{ "openapi": "3.0.0", "info": { "title": "Logistics API", "description": "[Logistics or fulfillment](https://help.vtex.com/en/tutorial/logistics--53udnvI5eBy8DKo8FOjMoP) is the process of planning and executing the transportation, storage of merchandise, and shipping orders to customers. You can accomplish all of this with the VTEX platform, which allows you to manage your inventory, shipping rates, pickup points and more.\r\n\r\n## Logistics API Index\r\n\r\n### Shipping Policies\r\n\r\n- `GET` [Retrieve shipping policy by ID](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/shipping-policies\/-id-)\r\n- `DELETE` [Delete shipping policies by ID](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#delete-\/api\/logistics\/pvt\/shipping-policies\/-id-)\r\n- `PUT` [Update shipping policy](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#put-\/api\/logistics\/pvt\/shipping-policies\/-id-)\r\n- `GET` [List shipping policies](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/shipping-policies)\r\n- `POST` [Create shipping policy](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/shipping-policies)\r\n\r\n### Freight Values\r\n\r\n- `POST` [Create\/update freight values](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/configuration\/freights\/-carrierId-\/values\/update)\r\n- `GET` [List freight values](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/freights\/-carrierId-\/-cep-\/values)\r\n\r\n### Scheduled Delivery\r\n\r\n- `GET` [Retrieve blocked delivery windows](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/carriers\/-carrierId-\/getdayofweekblocked)\r\n- `POST` [Add blocked delivery windows](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/configuration\/carriers\/-carrierId-\/adddayofweekblocked)\r\n- `POST` [Remove blocked delivery windows](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/configuration\/carriers\/-carrierId-\/removedayofweekblocked)\r\n- `GET` [Search capacity reservations in time range](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics-capacity\/resources\/carrier@-capacityType-@-shippingPolicyId-\/time-frames)\r\n- `GET` [Get capacity reservation usage by window](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics-capacity\/resources\/carrier@-capacityType-@-shippingPolicyId-\/time-frames\/-windowDay-F-windowStartTime-T-windowEndTime-)\r\n\r\n### Docks\r\n\r\n- `POST` [Create\/update dock](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/configuration\/docks)\r\n- `GET` [List all docks](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/docks)\r\n- `GET` [List dock by ID](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/docks\/-dockId-)\r\n- `DELETE` [Delete dock](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#delete-\/api\/logistics\/pvt\/configuration\/docks\/-dockId-)\r\n- `POST` [Activate dock](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/configuration\/docks\/-dockId-\/activation)\r\n- `POST` [Deactivate dock](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/configuration\/docks\/-dockId-\/deactivation)\r\n\r\n### Warehouses\r\n\r\n- `POST` [Create\/update warehouse](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/configuration\/warehouses)\r\n- `GET` [List all warehouses](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/warehouses)\r\n- `GET` [List warehouse by ID](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/warehouses\/-warehouseId-)\r\n- `DELETE` [Remove warehouse](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#delete-\/api\/logistics\/pvt\/configuration\/warehouses\/-warehouseId-)\r\n- `POST` [Activate warehouse](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/configuration\/warehouses\/-warehouseId-\/activation)\r\n- `POST` [Deactivate warehouse](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/configuration\/warehouses\/-warehouseId-\/deactivation)\r\n\r\n### Inventory\r\n\r\n- `GET` [List inventory by SKU](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/inventory\/skus\/-skuId-)\r\n- `GET` [List inventory per warehouse](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/inventory\/items\/-skuId-\/warehouses\/-warehouseId-)\r\n- `PUT` [Update inventory by SKU and warehouse](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#put-\/api\/logistics\/pvt\/inventory\/skus\/-skuId-\/warehouses\/-warehouseId-)\r\n- `PATCH` [Update inventory quantity by SKU and warehouse](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#patch-\/api\/logistics\/pvt\/inventory\/skus\/-skuId-\/warehouses\/-warehouseId-\/quantity)\r\n- `PATCH` [Update inventory lead time by SKU and warehouse](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#patch-\/api\/logistics\/pvt\/inventory\/skus\/-skuId-\/warehouses\/-warehouseId-\/lead-time)\r\n- `GET` [List inventory per dock](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/inventory\/items\/-skuId-\/docks\/-dockId-)\r\n- `GET` [List inventory per dock and warehouse](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/inventory\/items\/-skuId-\/docks\/-dockId-\/warehouses\/-warehouseId-)\r\n- `GET` [List inventory with dispatched reservations](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/inventory\/items\/-itemId-\/warehouses\/-warehouseId-\/dispatched)\r\n- `GET` [List supply lots](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/inventory\/items\/-skuId-\/warehouses\/-warehouseId-\/supplyLots)\r\n- `PUT` [Save supply lot](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#put-\/api\/logistics\/pvt\/inventory\/items\/-skuId-\/warehouses\/-warehouseId-\/supplyLots\/-supplyLotId-)\r\n- `POST` [Transfer supply lot](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/inventory\/items\/-skuId-\/warehouses\/-warehouseId-\/supplyLots\/-supplyLotId-\/transfer)\r\n\r\n### Holidays\r\n\r\n- `PUT` [Create\/update holiday](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#put-\/api\/logistics\/pvt\/configuration\/holidays\/-holidayId-)\r\n- `GET` [List holiday by ID](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/holidays\/-holidayId-)\r\n- `DELETE` [Delete holiday](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#delete-\/api\/logistics\/pvt\/configuration\/holidays\/-holidayId-)\r\n- `GET` [List all holidays](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/holidays)\r\n\r\n### Reservations\r\n\r\n- `POST` [Create reservation](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/inventory\/reservations)\r\n- `GET` [List reservation by ID](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/inventory\/reservations\/-reservationId-)\r\n- `POST` [Confirm reservation](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/inventory\/reservations\/-reservationId-\/confirm)\r\n- `POST` [Acknowledgment reservation](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/inventory\/reservations\/-reservationId-\/acknowledge)\r\n- `POST` [Cancel reservation](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/inventory\/reservations\/-reservationId-\/cancel)\r\n- `GET` [List reservation by warehouse and SKU](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/inventory\/reservations\/-warehouseId-\/-skuId-)\r\n\r\n### SLA\r\n\r\n- `POST` [Calculate SLA](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#post-\/api\/logistics\/pvt\/shipping\/calculate)\r\n\r\n### Pickup points\r\n\r\n- `GET` [List pickup points](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/pickuppoints)\r\n- `PUT` [Create\/Update Pickup Point](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#put-\/api\/logistics\/pvt\/configuration\/pickuppoints\/-pickupPointId-)\r\n- `GET` [List Pickup Point By ID](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/pickuppoints\/-pickupPointId-)\r\n- `DELETE` [Delete Pickup Point](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#delete-\/api\/logistics\/pvt\/configuration\/pickuppoints\/-pickupPointId-)\r\n- `GET` [List paged Pickup Points](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/pickuppoints\/_search)\r\n\r\n### Polygons\r\n\r\n- `GET` [List paged polygons](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/geoshape)\r\n- `PUT` [Create\/update polygon](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#put-\/api\/logistics\/pvt\/configuration\/geoshape)\r\n- `GET` [List polygon by ID](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#get-\/api\/logistics\/pvt\/configuration\/geoshape\/-polygonName-)\r\n- `DELETE` [Delete polygon](https:\/\/developers.vtex.com\/docs\/api-reference\/logistics-api#delete-\/api\/logistics\/pvt\/configuration\/geoshape\/-polygonName-) \r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |", "contact": {}, "version": "1.0" }, "servers": [ { "url": "https://{accountName}.{environment}.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" }, "environment": { "description": "Environment to use. Used as part of the URL.", "enum": [ "vtexcommercestable" ], "default": "vtexcommercestable" } } } ], "paths": { "/api/logistics/pvt/shipping-policies/{id}": { "get": { "tags": [ "Shipping policies" ], "summary": "Retrieve shipping policy by ID", "description": "Retrieves information from a [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) from your store, searching by shipping policy ID.\r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "id", "in": "path", "required": true, "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID.", "schema": { "type": "string", "example": "sp12" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingPolicy" }, "example": { "id": "store-sp-01", "name": "store-sp-01", "shippingMethod": "normal delivery", "weekendAndHolidays": { "saturday": true, "sunday": true, "holiday": true }, "maxDimension": { "largestMeasure": 0.0, "maxMeasureSum": 1100.0 }, "numberOfItemsPerShipment": 1, "minimumValueAceptable": 0.0, "maximumValueAceptable": 0.0, "additionalTime": "00:00:00", "additionalPrice": { "method": 0, "value": 0.0 }, "deliveryScheduleSettings": { "useDeliverySchedule": true, "dayOfWeekForDelivery": [ { "dayOfWeek": 1, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 2, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 3, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 4, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 5, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 6, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 0, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] } ], "maxRangeDelivery": 1, "dayOfWeekBlockeds": [ "2024-02-13T09:00:00", "2024-06-09T09:00:00" ] }, "carrierSchedule": [ { "dayOfWeek": 0, "timeLimit": "time_limit" } ], "cubicWeightSettings": { "volumetricFactor": 0.2, "minimunAcceptableVolumetricWeight": 0.0 }, "modalSettings": { "modals": [ "LIQUID" ], "useOnlyItemsWithDefinedModal": false }, "businessHourSettings": { "carrierBusinessHours": [ { "dayOfWeek": 1, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 2, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 3, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 4, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 5, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 6, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 0, "openingTime": "00:00:00", "closingTime": "23:59:59" } ], "isOpenOutsideBusinessHours": true }, "pickupPointsSettings": { "pickupPointIds": [ "Id1", "Id2" ], "pickupPointTags": [ "Tag1", "Tag2" ], "sellers": [ "Seller1" ] }, "processingStatus": { "status": 1, "errorMessage": null, "errorsMetadata": null }, "deliveryChannel": "delivery", "calculationType": 0, "isActive": true, "lastIndexedAt": "2024-05-30T14:13:34.158121+00:00", "shippingHoursSettings": { "shippingHours": [ { "dayOfWeek": 1, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 2, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 3, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 4, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 5, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 6, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 0, "openingTime": "00:00:00", "closingTime": "23:59:59" } ], "acceptOrdersOutsideShippingHours": true }, "carrierInfo": { "carrierAccountName": "vtexcorreios", "deliveryAgreementId": "d91dee11-6afb-4835-99bc-5r671a578076", "linkedDocks": [ { "id": "2656", "name": "CORREIOS 2656" } ], "readyToUse": true } } } } } } }, "delete": { "tags": [ "Shipping policies" ], "summary": "Delete shipping policy by ID", "description": "Deletes a [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) of your store, searching by shipping policy ID. \r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "id", "in": "path", "required": true, "description": "ID of the shipping policy.", "schema": { "type": "string", "example": "id" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Shipping policies" ], "summary": "Update shipping policy by ID", "description": "Updates information about a [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) of your store, searching by shipping policy ID. \r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "id", "in": "path", "required": true, "description": "Shipping policy ID.", "schema": { "type": "string", "example": "shippingpolicyid1" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "shippingMethod", "deliveryOnWeekends", "maxDimension", "isActive" ], "properties": { "name": { "type": "string", "description": "[Shipping policy]((https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name.", "example": "Correios PAC" }, "shippingMethod": { "type": "string", "description": "Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144).", "example": "Normal" }, "deliveryOnWeekends": { "type": "boolean", "description": "Defines if the delivery on weekends configuration is active (`true`) or not (`false`).", "example": false }, "maxDimension": { "type": "object", "description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).", "example": { "largestMeasure": 10.0, "maxMeasureSum": 30.0 }, "required": [ "largestMeasure", "maxMeasureSum" ], "properties": { "largestMeasure": { "type": "number", "description": "Largest measure acceptable of the package.", "example": 0.0 }, "maxMeasureSum": { "type": "number", "description": "Sum of all maximum measures of the package.", "example": 0.0 } } }, "cubicWeightSettings": { "type": "object", "description": "Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.", "properties": { "volumetricFactor": { "type": "number", "description": "Factor that will be used on the cubic weight calculation, usually given by the carrier.", "example": 0.2 }, "minimunAcceptableVolumetricWeight": { "type": "number", "description": "Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).", "example": 0.0 } } }, "modalSettings": { "type": "object", "description": "Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.", "properties": { "modals": { "type": "array", "description": "Type of special freight.", "items": { "type": "string", "enum": [ "CHEMICALS", "ELECTRONICS", "FURNITURE", "GLASS", "LIQUID", "MATTRESSES", "REFRIGERATED", "TIRES", "WHITE_GOODS", "FIREARMS" ], "description": "Modal values assigned to the special freight.", "example": "LIQUID" } }, "useOnlyItemsWithDefinedModal": { "type": "boolean", "description": "When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set.", "example": false } } }, "isActive": { "type": "boolean", "description": "Defines if the shipping policy is active (`true`) or inactive (`false`).", "example": true }, "deliveryScheduleSettings": { "type": "object", "description": "[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings.", "required": [ "useDeliverySchedule", "dayOfWeekForDelivery", "maxRangeDelivery" ], "properties": { "useDeliverySchedule": { "type": "boolean", "description": "Defines if the scheduled delivery configuration is active (`true`) or inactive (`false`).", "example": true }, "maxRangeDelivery": { "type": "number", "description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured maxRangeDelivery is equal 7, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the maxRangeDelivery set, this shipping policy won't be shown on the checkout.", "example": 0.0 }, "dayOfWeekForDelivery": { "type": "array", "description": "Select the chosen days of the week for delivery, from `0` (sunday) to `6` (saturday). Make sure to add the available hours, as shown in the example.", "items": { "type": "object", "description": "Configuration for delivery for a single day of the week.", "required": [ "dayOfWeek", "deliveryRanges" ], "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week, from `0` (Sunday) to `6` (Saturday).", "enum":[ 0, 1, 2, 3, 4, 5, 6 ], "example": 2 }, "deliveryRanges": { "type": "array", "description": "Reservation windows for scheduled delivery.", "items": { "type": "object", "description": "Delivery ranges object.", "required": [ "startTime", "endTime", "listPrice" ], "properties": { "startTime": { "type": "string", "description": "Start time for day of the week.", "example": "11:00:00" }, "endTime": { "type": "string", "description": "End time for day of the week.", "example": "12:30:00" }, "listPrice": { "type": "number", "description": "List price for day of the week.", "example": 0.0 }, "deliveryCapacity": { "type": "array", "description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.", "items": { "type": "object", "description": "Delivery capacity object.", "required": [ "capacityType", "maxValue" ], "properties": { "capacityType": { "type": "string", "description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).", "example": "ORDERS_QUANTITY" }, "maxValue": { "type": "number", "description": "Maximum number of orders or SKUs that the store is capable of fulfilling.", "example": 0.0 } } } } } } } } } } } } } } } } } } }, "/api/logistics/pvt/shipping-policies": { "get": { "tags": [ "Shipping policies" ], "summary": "List shipping policies", "description": "Lists all [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) from your store.\r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "page", "in": "query", "required": false, "description": "Number of the starting page of the response. When no value is sent, it starts in page `1`.", "schema": { "type": "integer", "example": 1 } }, { "name": "perPage", "in": "query", "required": false, "description": "Desired number of items per page, to retrieve information from your shipping policies.", "schema": { "type": "integer", "example": 15 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Paged shipping policies list.", "properties": { "items": { "type": "array", "description": "List of shipping policies related to the account.", "items": { "$ref": "#/components/schemas/ShippingPolicy" } }, "paging": { "type": "object", "description": "Pagination information.", "properties": { "page": { "type": "integer", "description": "Number of the current page of the response. By default, it returns page `1`." }, "perPage": { "type": "integer", "description": "Number of shipping policies per page." }, "total": { "type": "integer", "description": "Total number of existing shipping policies." }, "pages": { "type": "integer", "description": "Total number of pages, considering all shipping policies." } } } } }, "example": { "items": [ { "id": "store-sp-01", "name": "store-sp-01", "shippingMethod": "normal delivery", "weekendAndHolidays": { "saturday": true, "sunday": true, "holiday": true }, "maxDimension": { "largestMeasure": 0.0, "maxMeasureSum": 1100.0 }, "numberOfItemsPerShipment": 1, "minimumValueAceptable": 0.0, "maximumValueAceptable": 0.0, "additionalTime": "00:00:00", "additionalPrice": { "method": 0, "value": 0.0 }, "deliveryScheduleSettings": { "useDeliverySchedule": true, "dayOfWeekForDelivery": [ { "dayOfWeek": 1, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 2, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 3, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 4, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 5, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 6, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] }, { "dayOfWeek": 0, "deliveryRanges": [ { "startTime": "00:00:00", "endTime": "23:59:59", "listPrice": 0.0, "deliveryCapacity": null } ] } ], "maxRangeDelivery": 1, "dayOfWeekBlockeds": [ "2024-02-13T09:00:00", "2024-06-09T09:00:00" ] }, "carrierSchedule": [ { "dayOfWeek": 0, "timeLimit": "time_limit" } ], "cubicWeightSettings": { "volumetricFactor": 0.2, "minimunAcceptableVolumetricWeight": 0.0 }, "modalSettings": { "modals": [ "LIQUID" ], "useOnlyItemsWithDefinedModal": false }, "businessHourSettings": { "carrierBusinessHours": [ { "dayOfWeek": 1, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 2, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 3, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 4, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 5, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 6, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 0, "openingTime": "00:00:00", "closingTime": "23:59:59" } ], "isOpenOutsideBusinessHours": true }, "pickupPointsSettings": { "pickupPointIds": [ "Id1", "Id2" ], "pickupPointTags": [ "Tag1", "Tag2" ], "sellers": [ "Seller1" ] }, "processingStatus": { "status": 1, "errorMessage": null, "errorsMetadata": null }, "deliveryChannel": "delivery", "calculationType": 0, "isActive": true, "lastIndexedAt": "2024-05-30T14:13:34.158121+00:00", "shippingHoursSettings": { "shippingHours": [ { "dayOfWeek": 1, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 2, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 3, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 4, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 5, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 6, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 0, "openingTime": "00:00:00", "closingTime": "23:59:59" } ], "acceptOrdersOutsideShippingHours": true }, "carrierInfo": { "carrierAccountName": "vtexcorreios", "deliveryAgreementId": "d91dee11-6afb-4835-99bc-5r671a578076", "linkedDocks": [ { "id": "2656", "name": "CORREIOS 2656" } ], "readyToUse": true } } ], "paging": { "page": 1, "perPage": 15, "total": 43, "pages": 3 } } } } } } }, "post": { "tags": [ "Shipping policies" ], "summary": "Create shipping policy", "description": "Configure a new [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) for your store. \r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "shippingMethod", "weekendAndHolidays", "maxDimension", "numberOfItemsPerShipment", "minimumValueAceptable", "maximumValueAceptable", "deliveryScheduleSettings", "cubicWeightSettings", "modalSettings", "businessHourSettings", "pickupPointsSettings", "isActive" ], "properties": { "id": { "type": "string", "description": "ID of the shipping policy.", "example": "123" }, "name": { "type": "string", "description": "Name of the shipping policy.", "example": "Normal" }, "shippingMethod": { "type": "string", "description": "Type of shipping available for this shipping policy (carrier). Options shown on freight simulation.", "example": "Normal" }, "weekendAndHolidays": { "type": "object", "description": "If the shipping policy includes deliveries on weekends and holidays.", "example": { "saturday": false, "sunday": false, "holiday": false }, "required": [ "saturday", "sunday", "holiday" ], "properties": { "saturday": { "type": "boolean", "description": "Defines if the shipping policy allows deliveries on Saturdays (`true`), or not (`false`).", "example": false }, "sunday": { "type": "boolean", "description": "Defines if the shipping policy allows deliveries on Sundays (`true`), or not (`false`).", "example": false }, "holiday": { "type": "boolean", "description": "Defines if the shipping policy allows deliveries on holidays (`true`), or not (`false`).", "example": false } } }, "maxDimension": { "type": "object", "description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).", "example": { "largestMeasure": 15.0, "maxMeasureSum": 25.0 }, "required": [ "largestMeasure", "maxMeasureSum" ], "properties": { "largestMeasure": { "type": "number", "description": "Largest measure of the package.", "example": 0.0 }, "maxMeasureSum": { "type": "number", "description": "Sum of all maximum measures of the package.", "example": 0.0 } } }, "numberOfItemsPerShipment": { "type": "integer", "description": "Capacity of your store's logistics of shipment, determines number of items permitted per shipment.", "example": 5 }, "minimumValueAceptable": { "type": "number", "description": "Minimum value accepted by the carrier, to realize the shipping.", "example": 0.0 }, "maximumValueAceptable": { "type": "number", "description": "Maximum value accepted by the carrier, to realize the shipping.", "example": 0.0 }, "deliveryScheduleSettings": { "type": "object", "description": "Settings for the Scheduled Delivery feature.", "required": [ "useDeliverySchedule", "dayOfWeekForDelivery", "maxRangeDelivery" ], "properties": { "useDeliverySchedule": { "type": "boolean", "description": "Select the Scheduled Delivery configuration.", "example": true }, "maxRangeDelivery": { "type": "number", "description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured maxRangeDelivery is equal 7, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the maxRangeDelivery set, this shipping policy won't be shown on the checkout.", "example": 0.0 }, "dayOfWeekForDelivery": { "type": "array", "description": "Select the chosen days for delivery. Values for each day of the week are: `0` = Sunday, `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, `5` = Friday, `6` = Saturday. Make sure to add the available hours for the chosen days, following the example.", "items": { "type": "object", "description": "Day of the week for delivery object.", "required": [ "dayOfWeek", "deliveryRanges" ], "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week, from `0` (sunday) to `6` (saturday).", "example": 2 }, "deliveryRanges": { "type": "array", "description": "Reservation windows for scheduled delivery.", "items": { "type": "object", "description": "Delivery ranges object.", "required": [ "startTime", "endTime", "listPrice" ], "properties": { "startTime": { "type": "string", "description": "Start time for day of the week.", "example": "11:00:00" }, "endTime": { "type": "string", "description": "End time for day of the week.", "example": "12:30:00" }, "listPrice": { "type": "number", "description": "List price for day of the week.", "example": 0.0 }, "deliveryCapacity": { "type": "array", "description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.", "items": { "type": "object", "description": "Delivery capacity object.", "required": [ "capacityType", "maxValue" ], "properties": { "capacityType": { "type": "string", "description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).", "example": "ORDERS_QUANTITY" }, "maxValue": { "type": "number", "description": "Maximum number of orders or SKUs that the store is capable of fulfilling.", "example": 55.0 } } } } } } } } } } } }, "carrierSchedule": { "type": "array", "description": "Schedule sent by the carrier to configure the shipping policy.", "items": { "type": "object", "description": "Carrier schedule object.", "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week, from `0` (sunday) to `6` (saturday).", "example": 0 }, "timeLimit": { "type": "string", "description": "Time limit.", "example": "time_limit" } } } }, "cubicWeightSettings": { "type": "object", "description": "Measure including the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.", "required": [ "volumetricFactor", "minimunAcceptableVolumetricWeight" ], "properties": { "volumetricFactor": { "type": "number", "description": "Factor that will be used on the cubic weight calculation.", "example": 3.0 }, "minimunAcceptableVolumetricWeight": { "type": "number", "description": "Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).", "example": 5.0 } } }, "modalSettings": { "type": "object", "description": "Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.", "required": [ "modals", "useOnlyItemsWithDefinedModal" ], "properties": { "modals": { "type": "array", "description": "Type of special freight.", "items": { "type": "string", "enum": [ "CHEMICALS", "ELECTRONICS", "FURNITURE", "GLASS", "LIQUID", "MATTRESSES", "REFRIGERATED", "TIRES", "WHITE_GOODS", "FIREARMS" ], "description": "Modal values assigned to the special freight.", "example": "ELECTRONICS" } }, "useOnlyItemsWithDefinedModal": { "type": "boolean", "description": "Defines if the modal's configurations will apply only for items with a defined modal (`true`) or not (`false`).", "example": false } } }, "businessHourSettings": { "type": "object", "description": "Business hours configurations.", "required": [ "carrierBusinessHours", "isOpenOutsideBusinessHours" ], "properties": { "carrierBusinessHours": { "type": "array", "description": "Carrier business hours configurations for the week.", "items": { "type": "object", "description": "Carrier business hours configurations for a day of the week.", "required": [ "openingTime", "closingTime", "dayOfWeek" ], "properties": { "openingTime": { "type": "string", "description": "Opening time.", "example": "00:00:00" }, "closingTime": { "type": "string", "description": "Closing time.", "example": "23:59:59" }, "dayOfWeek": { "type": "integer", "description": "Day of the week, from `0` (Sunday) to `6` (Saturday).", "example": 1 } } } }, "isOpenOutsideBusinessHours": { "type": "boolean", "description": "Select whether the shipping policy allows deliveries outside business hours (`true`) or not (`false`).", "example": true } } }, "pickupPointsSettings": { "type": "object", "description": "Configuration for Pickup Points.", "nullable": true, "required": [ "pickupPointIds", "pickupPointTags", "sellers" ], "properties": { "pickupPointIds": { "type": "array", "description": "Insert the IDs for pickup points previously configured in your store.", "items":{ "type": "string", "description": "Pickup point IDs.", "example": "Id1" } }, "pickupPointTags": { "type": "array", "description": "Insert the tags for pickup points previously configured in your store.", "example": [ "Tag1", "Tag2" ], "items":{ "type": "string", "description": "Tag IDs.", "example": "Tag1" } }, "sellers": { "type": "array", "description": "Sellers that will be associated with the [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of the shipping policy being created.", "items":{ "type": "string", "description": "Seller names.", "example": "Seller1" } } } }, "isActive": { "type": "boolean", "description": "Defines if the shipping policy is active (`true`) or not (`false`).", "example": false } } } } } } } }, "/api/logistics/pvt/configuration/freights/{carrierId}/values/update": { "post": { "tags": [ "Freight values" ], "summary": "Create or update freight values", "description": "Creates or updates freight values for your store's carriers. Learn more in [Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Create/UpdateFreightValues", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "carrierId", "in": "path", "description": "Carrier ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "carrier123" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "Array of objects, each containing information on a specific freight interval.", "items": { "required": [ "absoluteMoneyCost", "country", "maxVolume", "operationType", "pricePercent", "pricePercentByWeight", "timeCost", "weightEnd", "weightStart", "zipCodeEnd", "zipCodeStart", "polygon" ], "type": "object", "description": "Freight interval object.", "properties": { "absoluteMoneyCost": { "type": "string", "description": "Fixed shipping cost to be charged in a decimal number.", "example": "1.00" }, "country": { "type": "string", "description": "Three letter ISO code for the country where the delivery will take place.", "example": "BRA" }, "maxVolume": { "type": "integer", "description": "Maximum volume that can be transported by the carrier in cm³.", "example": 1000000000 }, "operationType": { "type": "integer", "description": "Indicates desired action for the object. Possible values are `1` (Insert), `2` (Update) or `3`(Delete).", "example": 1 }, "pricePercent": { "type": "integer", "description": "[Price-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total price of the order, in decimal number. You must fill in this field with a percentage value. For example, for an additional charge of 10%, fill in the table with 10.", "example": 10 }, "pricePercentByWeight": { "type": "integer", "description": "[Weight-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total weight of the order.", "example": 0 }, "timeCost": { "type": "string", "description": "Delivery time frame informed by the carrier, in the format `DD.HH:MM:SS`.", "example": "2.00:00:00" }, "weightEnd": { "type": "integer", "description": "Maximum weight allowed.", "example": 1000 }, "weightStart": { "type": "integer", "description": "Minimum weight allowed.", "example": 1 }, "zipCodeEnd": { "type": "string", "description": "End of postal code interval.", "example": "1234500" }, "zipCodeStart": { "type": "string", "description": "Start of postal code interval.", "example": "1000000" }, "polygon": { "type": "string", "description": "Polygon ID, according to the [geolocation](https://help.vtex.com/en/tutorial/registering-geolocation/) feature.", "example": "polygon2" } } } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values": { "get": { "tags": [ "Freight values" ], "summary": "List freight values", "description": "Lists freight values appointed to your store's carriers, searching by carrier ID and postal code (`cep`). The information is retrieved from your [shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) configurations.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "FreightValues", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "carrierId", "in": "path", "description": "Carrier ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "carrier-123" } }, { "name": "cep", "in": "path", "description": "Postal code of the area in which you wish to retrieve freight values for a given carrier, according to your [shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) configurations.", "required": true, "style": "simple", "schema": { "type": "string", "example": "12345000" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List of freight values.", "items": { "required": [ "zipCodeStart", "zipCodeEnd", "weightStart", "weightEnd", "absoluteMoneyCost", "pricePercent", "pricePercentByWeight", "maxVolume", "timeCost", "country", "operationType", "restrictedFreights", "polygon", "minimumValueInsurance" ], "type": "object", "description": "Freight values object.", "properties": { "zipCodeStart": { "type": "string", "description": "Postal code interval starting point." }, "zipCodeEnd": { "type": "string", "description": "Postal code interval ending point." }, "weightStart": { "type": "number", "description": "Minimum weight allowed." }, "weightEnd": { "type": "number", "description": "Maximum weight allowed." }, "absoluteMoneyCost": { "type": "number", "description": "Fixed shipping cost to be charged, in a decimal number." }, "pricePercent": { "type": "number", "description": "[Price-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total price of the order, in decimal number. You must fill in this field with a percentage value. For example, for an additional charge of 10%, fill in the table with `10`." }, "pricePercentByWeight": { "type": "number", "description": "[Weight-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total weight of the order." }, "maxVolume": { "type": "number", "description": "Maximum volume that can be transported by the carrier in cm³." }, "timeCost": { "type": "string", "description": "Delivery time frame informed by the carrier, in the format `DD.HH:MM:SS`." }, "country": { "type": "string", "description": "Three letter ISO code for the country for the given postal code." }, "operationType": { "type": "integer", "description": "Indicates the operation type, which can be `1` (Insert), `2` (Update) or `3`(Delete)." }, "restrictedFreights": { "type": "array", "items": { "type": "string", "description": "Restricted freight postal codes." }, "description": "List of postal codes where the delivery is restricted for the given carrier.", "nullable": true }, "polygon": { "type": "string", "description": "Polygon ID, according to the [geolocation](https://help.vtex.com/en/tutorial/registering-geolocation/) feature." }, "minimumValueInsurance": { "type": "number", "description": "Insurance minimum value." } } } }, "example": [ { "zipCodeStart": "01000001", "zipCodeEnd": "05999999", "weightStart": 250.001, "weightEnd": 300.0, "absoluteMoneyCost": 329.9, "pricePercent": 0.0, "pricePercentByWeight": 0, "maxVolume": 100000000.0, "timeCost": "2.00:00:00", "country": "BRA", "operationType": 0, "restrictedFreights": [ "01056051" ], "polygon": "central_RJ", "minimumValueInsurance": 0 }, { "zipCodeStart": "01230020", "zipCodeEnd": "06959949", "weightStart": 1001.001, "weightEnd": 10000, "absoluteMoneyCost": 15.0, "pricePercent": 0.0, "pricePercentByWeight": 0, "maxVolume": 900000000, "timeCost": "1.00:00:00", "country": "BRA", "operationType": 0, "restrictedFreights": [], "polygon": "zone_RJ", "minimumValueInsurance": 0 } ] } } } } } }, "/api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked": { "get": { "tags": [ "Scheduled delivery" ], "summary": "Retrieve blocked delivery windows", "description": "Lists all blocked delivery windows of your store's shipping policies, searching by carrier ID.\n\r\n\r>⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "RetrieveBlockedDeliveryWindows", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "carrierId", "in": "path", "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID (carrier ID).", "required": true, "style": "simple", "schema": { "type": "string", "example": "carrier-123" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List of blocked delivery windows date and time.", "items": { "type": "string", "description": "Blocked delivery windows date and time in the format `YYYY-MM-DDTHH:MM:SS`. The time zone is set according to the store account." } }, "example": [ "2024-12-09T08:00:00", "2025-12-09T08:00:00" ] } } } } } }, "/api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked": { "post": { "tags": [ "Scheduled delivery" ], "summary": "Add blocked delivery windows", "description": "Adds blocked delivery windows for your store's shipping policies.\n\r\n\r>⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the account.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "AddBlockedDeliveryWindows", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "carrierId", "in": "path", "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID (carrier ID).", "required": true, "style": "simple", "schema": { "type": "string", "example": "carrier-123" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string", "description": "Delivery window block starting date and time in the format `YYYY-MM-DDTHH:MM:SS`. The time zone is set according to the store account. Requests with incorrect values will be disconsidered by the system (for example, a date in the past), regardless of a successful response.", "example": "2025-12-09T08:00:00" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "description": "Successful requests return the message `true`." }, "example": true } } } } } }, "/api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked": { "post": { "tags": [ "Scheduled delivery" ], "summary": "Remove blocked delivery windows", "description": "Removes blocked delivery windows configured for a shipping policy of your [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3).\n\r\n\r>⚠️ While most of our endpoints return time values in UTC format, this endpoint returns time adjusted to the time zone set for the account.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "RemoveBlockedDeliveryWindows", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "carrierId", "in": "path", "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID (carrier ID).", "required": true, "style": "simple", "schema": { "type": "string", "example": "carrier-123" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string", "description": "Date and time of the delivery window block being removed, in the format `YYYY-MM-DDTHH:MM:SS`. The time zone is set according to the store account.", "example": "2024-12-09T08:00:00" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "description": "Successful requests return the message `true`." }, "example": true } } } } } }, "/api/logistics/pvt/configuration/docks": { "post": { "tags": [ "Docks" ], "summary": "Create or update dock", "description": "Creates a new [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) or updates an existing one for your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Create/UpdateDock", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "id", "name", "priority", "dockTimeFake", "timeFakeOverhead", "salesChannels", "salesChannel", "freightTableIds", "wmsEndPoint", "address" ], "type": "object", "properties": { "id": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.", "example": "1a8bce3" }, "name": { "type": "string", "description": "Loading dock name.", "example": "Catete dock_3" }, "priority": { "type": "integer", "description": "Value used as a tie-breaking rule when selecting a loading dock.", "example": 0 }, "dockTimeFake": { "type": "string", "description": "Loading dock handling time in the format `DD.HH:MM:SS`.", "deprecated": true, "example": "00:00:00" }, "timeFakeOverhead": { "type": "string", "description": "Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen. \r\n>ℹ️ This field is not considered when calculating the delivery time.", "example": "00:00:00" }, "salesChannels": { "type": "array", "items": { "type": "string", "description": "Sales channel (trade policy) numbers.", "example": "3" }, "description": "Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) to associate with the loading dock." }, "salesChannel": { "type": "string", "description": "Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) to associate with the loading dock.", "example": "1" }, "freightTableIds": { "type": "array", "description": "List with freight table IDs.", "items": { "type": "string", "description": "Freight table IDs.", "example": "11cc4b6" } }, "wmsEndPoint": { "type": "string", "description": "Warehouse Management System (WMS) fulfillment endpoint.", "example": null, "nullable": true }, "address": { "type": "object", "description": "Dock address object.", "required": [ "postalCode", "country", "city", "state", "neighborhood", "street", "number", "complement", "coordinates" ], "properties": { "postalCode": { "type": "string", "description": "Dock address postal code.", "example": "02220070" }, "country": { "required": [ "acronym", "name" ], "type": "object", "description": "Dock address country object.", "properties": { "acronym": { "type": "string", "description": "Three letter ISO code for the dock address country.", "example": "BRA" }, "name": { "type": "string", "description": "Dock address country name.", "example": "Brazil" } } }, "city": { "type": "string", "description": "Dock address city.", "example": "Rio de Janeiro" }, "state": { "type": "string", "description": "Dock address state.", "example": "RJ" }, "neighborhood": { "type": "string", "description": "Dock address neighborhood.", "example": "Catete" }, "street": { "type": "string", "description": "Dock address street.", "example": "Artur Bernardes Street" }, "number": { "type": "string", "description": "Dock address number.", "example": "100" }, "complement": { "type": "string", "description": "Dock address complement.", "example": "apartment" }, "coordinates": { "type": "array", "description": "Dock address geolocation coordinates.", "items": { "type": "array", "description": "Geolocation coordinates, first longitude then latitude.", "example": [ -34.82939147949219, -7.115228652954102 ], "items": { "type": "number", "description": "Longitude or latitude.", "example": -34.82939147949219 } } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "description": "Successful requests return the message `true`." }, "example": true } } } } }, "get": { "tags": [ "Docks" ], "summary": "List all docks", "description": "Retrieves information about all [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "AllDocks", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List with docks information.", "items": { "$ref": "#/components/schemas/ListDocksById" } }, "example": [ { "pickupStoreInfo": { "isPickupStore": false, "storeId": null, "friendlyName": null, "address": { "postalCode": "01001-000", "country": { "acronym": "BRA", "name": "Brasil" }, "city": "São Paulo", "state": "SP", "neighborhood": "Sé", "street": "Praça da Sé", "number": "100", "complement": null, "reference": "Next to the pink building", "location": { "latitude": -46.6342009, "longitude": -23.5503099 } }, "additionalInfo": null, "dockId": null, "distance": null, "businessHours": null, "pickupHolidays": null, "sellerId": null, "isThirdPartyPickup": false }, "storeId": null, "pickupInStoreInfo": { "isActice": false, "additionalInfo": null }, "deliveryFromStoreInfo": { "isActice": false, "deliveryRadius": 0.0, "deliveryFee": 0.0, "deliveryTime": "00:00:00", "maximumWeight": 0.0 }, "address": { "postalCode": "01001-000", "country": { "acronym": "BRA", "name": "Brasil" }, "city": "São Paulo", "state": "SP", "neighborhood": "Sé", "street": "Praça da Sé", "number": "", "complement": null, "reference": null, "location": { "latitude": -46.6342009, "longitude": -23.5503099 } }, "location": null, "shippingRatesProviders": [], "deliveryAgreementsIds": [], "id": "1aa131g", "name": "Dock Pac", "priority": 0, "dockTimeFake": "00:00:00", "timeFakeOverhead": "00:00:00", "salesChannels": [ "1", "2", "3" ], "freightTableIds": [ "1602051" ], "wmsEndPoint": null, "isActive": true }, { "pickupStoreInfo": { "isPickupStore": false, "storeId": null, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null, "distance": null, "businessHours": null, "pickupHolidays": null, "sellerId": null, "isThirdPartyPickup": false }, "storeId": null, "pickupInStoreInfo": { "isActice": false, "additionalInfo": null }, "deliveryFromStoreInfo": { "isActice": false, "deliveryRadius": 0.0, "deliveryFee": 0.0, "deliveryTime": "00:00:00", "maximumWeight": 0.0 }, "address": { "postalCode": "22220070", "country": { "acronym": "BRA", "name": "Brazil" }, "city": "Rio de Janeiro", "state": "RJ", "neighborhood": "Catete", "street": "Artur Bernardes Street", "number": "100", "complement": "apartment", "coordinates": [ -34.82939147949219, -7.115228652954102 ] }, "location": { "zipCode": "22220070", "country": "BRA", "inStore": { "IsCheckedIn": false, "StoreId": null } }, "shippingRatesProviders": [], "deliveryAgreementsIds": [], "id": "doc_dockTest", "name": "Central dock", "priority": 0, "dockTimeFake": "00:00:00", "timeFakeOverhead": "00:00:00", "salesChannels": [ "1" ], "salesChannel": "1", "freightTableIds": [ "andreia-sp-01" ], "wmsEndPoint": null, "isActive": true } ] } } } } } }, "/api/logistics/pvt/configuration/docks/{dockId}": { "get": { "tags": [ "Docks" ], "summary": "List dock by ID", "description": "Retrieves information about a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "DockById", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "dockId", "in": "path", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "dock_1f95" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDocksById" }, "example": { "pickupStoreInfo": { "isPickupStore": false, "storeId": null, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null, "distance": null, "businessHours": null, "pickupHolidays": null, "sellerId": null, "isThirdPartyPickup": false }, "storeId": null, "pickupInStoreInfo": { "isActice": false, "additionalInfo": null }, "deliveryFromStoreInfo": { "isActice": false, "deliveryRadius": 0.0, "deliveryFee": 0.0, "deliveryTime": "00:00:00", "maximumWeight": 0.0 }, "address": { "postalCode": "22220070", "country": { "acronym": "BRA", "name": "Brazil" }, "city": "Rio de Janeiro", "state": "RJ", "neighborhood": "Catete", "street": "Artur Bernardes Street", "number": "100", "complement": "apartment", "reference": "Next to the pink building", "location": { "latitude": -34.82939147949219, "longitude": -7.115228652954102 } }, "location": { "zipCode": "22220070", "country": "BRA", "inStore": { "IsCheckedIn": false, "StoreId": null } }, "shippingRatesProviders": [], "deliveryAgreementsIds": [], "id": "doc_dockTest", "name": "Central dock", "priority": 0, "dockTimeFake": "00:00:00", "timeFakeOverhead": "00:00:00", "salesChannels": [ "1" ], "salesChannel": "1", "freightTableIds": [ "andreia-sp-01" ], "wmsEndPoint": null, "isActive": true } } } } } }, "delete": { "tags": [ "Docks" ], "summary": "Delete dock", "description": "Deletes a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj), searching by dock ID.\r\n\r\nSuccessful requests receive a `200 OK` status code with `true` in the response body.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Dock", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "dockId", "in": "path", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "dock_1f95" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "description": "Successful requests return the message `true`." }, "example": true } } } } } }, "/api/logistics/pvt/configuration/docks/{dockId}/activation": { "post": { "tags": [ "Docks" ], "summary": "Activate dock", "description": "Activates a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "ActivateDock", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "dockId", "in": "path", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "dock_1f95" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/logistics/pvt/configuration/docks/{dockId}/deactivation": { "post": { "tags": [ "Docks" ], "summary": "Deactivate dock", "description": "Deactivates a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "DeactivateDock", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "dockId", "in": "path", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "dock_1f95" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/logistics/pvt/configuration/warehouses": { "post": { "tags": [ "Warehouses" ], "summary": "Create or update warehouse", "description": "Creates or updates a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Create/UpdateWarehouse", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "id", "name", "warehouseDocks" ], "type": "object", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) to be created or updated.", "properties": { "id": { "type": "string", "description": "Warehouse ID.", "example": "15bfc76" }, "name": { "type": "string", "description": "Warehouse name.", "example": "Main warehouse" }, "warehouseDocks": { "type": "array", "description": "List of [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) to associate with the warehouse.", "items": { "type": "object", "description": "Loading dock details.", "required": [ "dockId", "name", "time", "cost", "translateDays", "costToDisplay" ], "properties": { "dockId": { "type": "string", "description": "Loading dock ID.", "example": "1a8bce3" }, "name": { "type": "string", "description": "Loading dock name.", "example": "Central dock" }, "time": { "type": "string", "description": "Loading dock processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.", "example": "3.00:00:00" }, "cost": { "type": "string", "description": "Extra charges added to the shipping rate when **Additional shipping costs** are configured.", "example": "5.00" }, "translateDays": { "type": "string", "description": "Translate days.", "example": "days" }, "costToDisplay": { "type": "string", "description": "Cost to display.", "example": "5,00" } } } }, "priority": { "type": "integer", "description": "Optional configuration of the warehouse priority. When no priority was set, it corresponds to `0`.", "example": 0 }, "isActive": { "type": "boolean", "description": "Defines if the warehous is active (`true`) or not (`false`).", "example": true } } } } } }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Warehouses" ], "summary": "List all warehouses", "description": "Lists all [warehouses](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) set up in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "AllWarehouses", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Each object contains details about a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).", "properties": { "id": { "type": "string", "description": "Warehouse ID." }, "name": { "type": "string", "description": "Warehouse name." }, "warehouseDocks": { "type": "array", "description": "List of [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the warehouse.", "items": { "type": "object", "description": "Loading dock information.", "properties": { "dockId": { "type": "string", "description": "Loading dock ID." }, "time": { "type": "string", "description": "Loading dock processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`." }, "cost": { "type": "number", "description": "Extra charges added to the shipping rate when **Additional shipping costs** are configured." } } } }, "pickupPointIds": { "type": "array", "description": "List of [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) associated with the warehouse.", "items":{ "type": "string", "description": "Pickup point ID." } }, "priority": { "type": "integer", "description": "Warehouse priority. When no priority was set, it corresponds to `0`." }, "isActive": { "type": "boolean", "description": "Shows if the warehouse is active (`true`) or inactive (`false`)." } } } }, "example": [ { "id": "1937054", "name": "Main warehouse", "warehouseDocks": [ { "dockId": "1_1_1", "time": "1.00:00:00", "cost": 0 } ], "pickupPointIds": [ "345", "136", "189" ], "priority": 0, "isActive": true }, { "id": "140ac66", "name": "Warehouse B", "warehouseDocks": [ { "dockId": "139270d", "time": "00:00:00", "cost": 0 } ], "pickupPointIds": [ "145", "412", "221" ], "priority": 0, "isActive": true } ] } } } } } }, "/api/logistics/pvt/configuration/warehouses/{warehouseId}": { "get": { "tags": [ "Warehouses" ], "summary": "List warehouse by ID", "description": "Retrieves information of a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "WarehouseById", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "warehouseId", "in": "path", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "warehouse_68d7" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." }, "name": { "type": "string", "description": "Warehouse name." }, "warehouseDocks": { "type": "array", "description": "List of [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the warehouse.", "items": { "type": "object", "description": "Loading dock information.", "properties": { "dockId": { "type": "string", "description": "Loading dock ID." }, "time": { "type": "string", "description": "Loading dock processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`." }, "cost": { "type": "number", "description": "Extra charges added to the shipping rate when **Additional shipping costs** are configured." } } } }, "pickupPointIds": { "type": "array", "description": "List of [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) associated with the warehouse.", "items":{ "type": "string", "description": "Pickup point ID." } }, "priority": { "type": "integer", "description": "Warehouse priority. When no priority was set, it corresponds to `0`." }, "isActive": { "type": "boolean", "description": "Shows if the warehouse is active (`true`) or inactive (`false`)." } } }, "example": { "id": "15bfc76", "name": "Main warehouse", "warehouseDocks": [ { "dockId": "1a8bce3", "time": "3.00:00:00", "cost": 5 } ], "pickupPointIds": [ "345", "136", "189" ], "priority": 0, "isActive": true } } } } } }, "delete": { "tags": [ "Warehouses" ], "summary": "Remove warehouse", "description": "Deletes a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "RemoveWarehouse", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "warehouseId", "in": "path", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "warehouse_68d7" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/configuration/warehouses/{warehouseId}/activation": { "post": { "tags": [ "Warehouses" ], "summary": "Activate warehouse", "description": "Activates a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "ActivateWarehouse", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "warehouseId", "in": "path", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "warehouse_68d7" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/configuration/warehouses/{warehouseId}/deactivation": { "post": { "tags": [ "Warehouses" ], "summary": "Deactivate warehouse", "description": "Deactivates a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "DeactivateWarehouse", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "warehouseId", "in": "path", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "warehouse_68d7" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/inventory/skus/{skuId}": { "get": { "tags": [ "Inventory" ], "summary": "List inventory by SKU", "description": "Lists [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information, searching by SKU ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "InventoryBySku", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "skuId", "in": "path", "description": "Every SKU has a unique identifier called SKU ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "36" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "skuId": { "type": "string", "description": "SKU ID." }, "balance": { "type": "array", "description": "List with warehouses' inventory details.", "items": { "type": "object", "description": "Warehouse inventory details.", "properties": { "warehouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." }, "warehouseName": { "type": "string", "description": "Warehouse name." }, "totalQuantity": { "type": "integer", "format": "int32", "description": "Total quantity of items of the given SKU." }, "reservedQuantity": { "type": "integer", "format": "int32", "description": "SKU reserved quantity." }, "hasUnlimitedQuantity": { "type": "boolean", "description": "When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock." }, "timeToRefill": { "type": "string", "description": "Time to refill.", "nullable": true }, "dateOfSupplyUtc": { "type": "string", "description": "Supply date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.", "nullable": true }, "leadTime": { "type": "string", "description": "[Lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) is an optional time configuration you can make for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and will be considered for shipping date calculation. The format is `DD.HH:MM:SS`." } } } } } }, "example": { "skuId": "10", "balance": [ { "warehouseId": "1fabf84", "warehouseName": "Main Warehouse", "totalQuantity": 0, "reservedQuantity": 0, "hasUnlimitedQuantity": false, "timeToRefill": null, "dateOfSupplyUtc": null, "leadTime": "00:00:00" }, { "warehouseId": "14e3fcc", "warehouseName": "Warehouse dew56", "totalQuantity": 0, "reservedQuantity": 0, "hasUnlimitedQuantity": false, "timeToRefill": null, "dateOfSupplyUtc": null, "leadTime": "1.00:00:00" }, { "warehouseId": "102e53e", "warehouseName": "wh-03", "totalQuantity": 0, "reservedQuantity": 0, "hasUnlimitedQuantity": false, "timeToRefill": null, "dateOfSupplyUtc": null, "leadTime": "00:00:00" } ] } } } } } } }, "/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}": { "get": { "tags": [ "Inventory" ], "summary": "List inventory per warehouse", "description": "Lists [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information, searching by [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Inventoryperwarehouse", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "skuId", "in": "path", "description": "SKU unique identifier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "36" } }, { "name": "warehouseId", "in": "path", "description": "Warehouse ID is the unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).", "required": true, "style": "simple", "schema": { "type": "string", "example": "whs15hs6c" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Inventory information for a given warehouse.", "properties": { "skuId": { "type": "string", "description": "SKU ID." }, "warehouseId": { "type": "string", "description": "Warehouse ID." }, "dockId": { "type": "string", "description": "Dock ID." }, "totalQuantity": { "type": "integer", "description": "Total quantity of SKU." }, "reservedQuantity": { "type": "integer", "description": "Reserved quantity of the SKU." }, "availableQuantity": { "type": "integer", "description": "Amount of items available for sale. Difference between total quantity and reserved quantity." }, "isUnlimited": { "type": "boolean", "description": "Indicates whether the SKU's availability is unlimited (\"unlimited inventory\")." }, "salesChannel": { "type": "array", "description": "List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated.", "items": { "type": "string", "description": "Sales channel (trade policy) ID." } }, "deliveryChannel": { "type": "array", "description": "List of delivery channels available.", "items": { "type": "string", "description": "Delivery channel type available." } }, "timeToRefill": { "type": "string", "description": "Time to refill.", "deprecated": true }, "dateOfSupplyUtc": { "type": "string", "description": "Date of supply lot in UTC." }, "keepSellingAfterExpiration": { "type": "boolean", "description": "Indicates whether SKU can continue to be sold after the available quantity gets to 0." }, "transfer": { "type": "string", "description": "Transfer." } } } }, "example": [ { "skuId": "1", "warehouseId": "1", "dockId": "1", "totalQuantity": 1000000, "reservedQuantity": 0, "availableQuantity": 1000000, "isUnlimited": true, "salesChannel": [ "1" ], "deliveryChannels": [ "delivery" ], "timeToRefill": "1", "dateOfSupplyUtc": "12020-04-05T00:00:00+00:00", "supplyLotId": "05-05-22", "keepSellingAfterExpiration": false, "transfer": "Transfer 1" } ] } } } } } }, "/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}": { "put": { "tags": [ "Inventory" ], "summary": "Update inventory by SKU and warehouse", "description": "Updates [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) quantity and [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) for a given SKU in a warehouse.\r\n\r\n>ℹ️ If you wish to configure lead time exclusively, use the [Update inventory lead time by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#patch-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-/lead-time) endpoint, and if the quantity only, use the [Update inventory quantity by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#patch-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-/quantity) endpoint. \r\n\r\nThis endpoint allows you to: \r\n\r\n- **Define a quantity:** Indicate a specific number of items of a SKU from a warehouse, and it will decrease whenever an item is sold. When the last item is sold, the SKU will run out of stock. \r\n\r\n- **Set an unlimited inventory:** Always have items of a SKU from a warehouse considered available for sale. When this configuration is active, the SKU never goes out of stock. \r\n\r\n- **Configure lead time:** Set the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) for a given SKU from a warehouse, and this period will be added to the order total shipping time. This configuration is optional and by default it is set to `0` days. \r\n\r\nSuccessful requests receive a `200 OK` status code with `true` in the response body, and unsuccessful requests receive a `400 Bad Request` error code. \r\n\r\n>❗ Requests made with an incomplete response body can be successful and receive a `200 OK` message. However, sending the request body without the `leadTime` field sets the SKU [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) to `0`. The same is valid for the `quantity` field, which, if not sent, makes the SKU count equal to `0`. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication.", "operationId": "UpdateInventoryBySkuandWarehouse", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "skuId", "in": "path", "description": "Unique identifier of the SKU you wish to update.", "required": true, "style": "simple", "schema": { "type": "string", "example": "25" } }, { "name": "warehouseId", "in": "path", "description": "Unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) of the SKU you wish to update.", "required": true, "style": "simple", "schema": { "type": "string", "example": "store-warehouse" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "quantity", "unlimitedQuantity", "leadTime" ], "type": "object", "properties": { "quantity": { "type": "integer", "format": "int32", "description": "Quantity of SKU units you wish to update the [inventory](https://help.vtex.com/tutorial/inventory-management--tutorials_139) in the given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). Note that:\r\n\r\n- Sending it as `null` sets the quantity to `0`.\r\n\r\n- Not sending it sets the quantity to `0`.\r\n\r\n- Sending `unlimitedQuantity` as `true` overrules the `quantity`.", "example": 202 }, "unlimitedQuantity": { "type": "boolean", "description": "When set as `true`, you make the SKU from the given warehouse permanently available for sales. No matter how many units are sold, the default quantity of `1000000` units does not decrease, and the store never runs out of stock. When set as `false`, every sold unit will decrease your inventory quantity. Note that:\r\n\r\n- Sending this field as `null` sets the value to `false`.\r\n\r\n- Not sending this field sets the value to `false`.\r\n\r\n- Sending this field as `true` overrules the `quantity` field.", "example": false }, "dateUtcOnBalanceSystem": { "type": "string", "description": "Defines the date and time of the warehouse when the SKU was updated. This can be useful for liberating handling order [reservations](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92), for example. The format is [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. \r\nWhen the value is `null` or empty, the default will be the date and time of the request being made.", "example": "2024-06-13T00:52:16" }, "leadTime": { "type": "string", "description": "Defines the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B), which is an optional time configuration you can make for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers.\r\n\r\nThe lead time is a part of the total shipping time and will be considered for shipping date calculation.\r\n\r\nThe format is `dd.hh:mm:ss` (days.hours:minutes:seconds). Note that:\r\n\r\n- Sending this field as `null` sets the value to `0`.\r\n\r\n- Not sending this field sets the value to `0`.", "example": "10.10:00:00" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "423": { "description": "Locked", "content": { "text/plain": { "schema": { "type": "string", "description": "When too many inventory update requests are made within milliseconds for the same SKU, warehouse, and seller, you can receive a status code response `423 Locked`, meaning only the first request was accepted by the platform, and the others were discarded. You must wait a few seconds before making another request. This platform constraint objective is to increase merchants' control and precision and prevent errors." }, "example": "Unable to acquire lock for key: {{accountName}}_item_logistics_{{skuId}}_{{warehouseId}}." } } } } } }, "/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}/quantity": { "patch": { "tags": [ "Inventory" ], "summary": "Update inventory quantity by SKU and warehouse", "description": "Updates [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) with a SKU count and availability for a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). You can do it in two ways: \r\n\r\n- **Define a quantity:** Indicate a specific number of items of a SKU from a warehouse, and it will decrease whenever an item is sold. When the last item is sold, the SKU will run out of stock. \r\n\r\n- **Set an unlimited inventory:** Always have items of a SKU from a warehouse considered available for sales. When this configuration is active, the SKU never runs out of stock. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication.", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "skuId", "in": "path", "description": "Unique identifier of the SKU you wish to update.", "required": true, "style": "simple", "schema": { "type": "string", "example": "25" } }, { "name": "warehouseId", "in": "path", "description": "Unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) of the SKU you wish to update.", "required": true, "style": "simple", "schema": { "type": "string", "example": "storeWarehouse" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "quantity", "unlimitedQuantity" ], "type": "object", "properties": { "quantity": { "type": "integer", "description": "Number of items you wish to update in your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) for a SKU from a given warehouse. \r\n\r\nNote that sending the field `unlimitedQuantity` as `true` overrules the `quantity`.", "example": 201 }, "unlimitedQuantity": { "type": "boolean", "description": "When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock. \r\n\r\nNote that sending this field as `true` overrules the `quantity`.", "example": false }, "dateUtcOnBalanceSystem": { "type": "string", "description": "Defines the date and time of the warehouse when the SKU was updated. This can be useful for liberating handling order [reservations](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92), for example. \r\n\r\nThe format is [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. When the value is `null` or empty, the default will be the date and time of the when the request being made.", "example": "2024-01-31T19:12:01.025662+00:00" } } } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" } } } }, "/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}/lead-time": { "patch": { "tags": [ "Inventory" ], "summary": "Update inventory lead time by SKU and warehouse", "description": "Configures the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) for a SKU of a warehouse, and the period is added to the order's total shipping time.\r\n\r\nAmong other [main use cases](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B#main-use-cases), lead time can represent an item's manufacturing time or scenarios where there are third-party suppliers, for example.\r\n\r\nLead time is an optional configuration and by default is set to `0` days.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "skuId", "in": "path", "description": "Unique identifier of the SKU you wish to update.", "required": true, "style": "simple", "schema": { "type": "string", "example": "25" } }, { "name": "warehouseId", "in": "path", "description": "Unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) of the SKU you wish to update.", "required": true, "style": "simple", "schema": { "type": "string", "example": "storeWarehouse" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "leadTime" ], "type": "object", "properties": { "leadTime": { "type": "string", "description": "Defines the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B), a configuration for shipping time at SKU level. You can set a shipping period for a warehouse SKU, and this time will be added to the order's total shipping time. Note that: \r\n\r\n- The format is `DD.HH:MM:SS`, or `DD`. The endpoint allows configuring hours and minutes, but the UI only shows days. \r\n\r\n- If you mistake hours for days, the system will accept the value as days. For example, sending `78:00:00` updates the lead time to 78 days. \r\n\r\n- Sending an empty field or a value in an incorrect format will result in a `400 Bad Request`.", "example": "8.00:00:00" } } } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" } } } }, "/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}": { "get": { "tags": [ "Inventory" ], "summary": "List inventory per dock", "description": "Lists inventory information, searching by [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Inventoryperdock", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "skuId", "in": "path", "description": "SKU unique identifier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "36" } }, { "name": "dockId", "in": "path", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "dock13a" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Loading dock inventory information.", "properties": { "skuId": { "type": "string", "description": "SKU ID." }, "warehouseId": { "type": "string", "description": "Warehouse ID." }, "dockId": { "type": "string", "description": "Dock ID." }, "totalQuantity": { "type": "integer", "description": "Total quantity of SKU." }, "reservedQuantity": { "type": "integer", "description": "Reserved quantity of the SKU." }, "availableQuantity": { "type": "integer", "description": "Amount of items available for sales. Difference between total quantity and reserved quantity." }, "isUnlimited": { "type": "boolean", "description": "Indicates whether the SKU's availability is unlimited (\"unlimited inventory\")." }, "salesChannel": { "type": "array", "description": "List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated.", "items": { "type": "string", "description": "Sales channel ID." } }, "deliveryChannel": { "type": "array", "description": "List of delivery channels available.", "items": { "type": "string", "description": "Delivery channel type available." } }, "timeToRefill": { "type": "string", "description": "Time to refill.", "deprecated": true }, "dateOfSupplyUtc": { "type": "string", "description": "Date of supply lot in UTC." }, "keepSellingAfterExpiration": { "type": "boolean", "description": "Indicates whether SKU can continue to be sold after the available quantity gets to 0." }, "transfer": { "type": "string", "description": "Transfer supply lot." } } } }, "example": [ { "skuId": "1", "warehouseId": "1", "dockId": "1", "totalQuantity": 1000000, "reservedQuantity": 0, "availableQuantity": 1000000, "isUnlimited": true, "salesChannel": [ "1" ], "deliveryChannels": [ "delivery" ], "timeToRefill": "01:50:00", "dateOfSupplyUtc": "2020-04-05T00:00:00+00:00", "supplyLotId": null, "keepSellingAfterExpiration": false, "transfer": "transfer1" }, { "skuId": "1", "warehouseId": "1_1", "dockId": "1", "totalQuantity": 1000117, "reservedQuantity": 117, "availableQuantity": 1000000, "isUnlimited": true, "salesChannel": [ "1" ], "deliveryChannels": [ "delivery" ], "timeToRefill": "01:50:00", "dateOfSupplyUtc": "2020-04-05T00:00:00+00:00", "supplyLotId": null, "keepSellingAfterExpiration": false, "transfer": "transfer2" } ] } } } } } }, "/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}/warehouses/{warehouseId}": { "get": { "tags": [ "Inventory" ], "summary": "List inventory per dock and warehouse", "description": "Lists inventory information from the combination of a given [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) and a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Inventoryperdockandwarehouse", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "skuId", "in": "path", "description": "SKU unique identifier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "36" } }, { "name": "dockId", "in": "path", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "dock13a" } }, { "name": "warehouseId", "in": "path", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "whs15hs6c" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Inventory information for the given dock and warehouse.", "properties": { "skuId": { "type": "string", "description": "SKU ID." }, "warehouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." }, "dockId": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." }, "totalQuantity": { "type": "integer", "description": "Total quantity of SKU." }, "reservedQuantity": { "type": "integer", "description": "Reserved quantity of the SKU." }, "availableQuantity": { "type": "integer", "description": "Amount of items available for sales. Difference between total quantity and reserved quantity." }, "isUnlimited": { "type": "boolean", "description": "Indicates if the unlimited inventory is activated so the SKU's availability is unlimited (`true`) or not (`false`)." }, "salesChannel": { "type": "array", "description": "List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated.", "items": { "type": "string", "description": "Sales channel ID." } }, "deliveryChannel": { "type": "array", "description": "List of delivery channels available.", "items": { "type": "string", "description": "Delivey channel type." } }, "timeToRefill": { "type": "string", "description": "Time to refill (deprecated)." }, "dateOfSupplyUtc": { "type": "string", "description": "Date of supply lot in UTC." }, "keepSellingAfterExpiration": { "type": "boolean", "description": "Indicates whether SKU can continue to be sold after the available quantity gets to 0." }, "transfer": { "type": "string", "description": "Transfer." } } } }, "example": [ { "skuId": "1", "warehouseId": "1", "dockId": "1", "totalQuantity": 1000000, "reservedQuantity": 0, "availableQuantity": 1000000, "isUnlimited": true, "salesChannel": [ "1" ], "deliveryChannels": [ "delivery" ], "timeToRefill": "12:50:00", "dateOfSupplyUtc": "2020-04-05T00:00:00+00:00", "supplyLotId": null, "keepSellingAfterExpiration": false, "transfer": "Tranfer1" } ] } } } } } }, "/api/logistics/pvt/inventory/items/{itemId}/warehouses/{warehouseId}/dispatched": { "get": { "tags": [ "Inventory" ], "summary": "List inventory with dispatched reservations", "description": "[Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) is the VTEX solution that prevents stores from selling the same item more than once. Adding products to the shopping cart does not create a reservation, this only happens after the shopper completes the purchase.\r\n\r\nThis endpoint lists your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information about dispatched reservations from a given warehouse. A reservation is considered dispatched after the order has passed the `authorize-fulfillment` status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) and is not canceled.\r\n\r\n**Response 400 Bad Request:** When the store has more than 2.000 active reservations, you receive a `400 Bad Request` error with the message: _Too many active reservations_.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Getinventorywithdispatchedreservations", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "itemId", "in": "path", "description": "SKU unique identifier called SKU ID. This field is an equivalent to `skuId`.", "required": true, "style": "simple", "schema": { "type": "string", "example": "89" } }, { "name": "warehouseId", "in": "path", "description": "Warehouse ID is the unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).", "required": true, "style": "simple", "schema": { "type": "string", "example": "warehouse-1-StoreName" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Inventory information.", "properties": { "skuId": { "type": "string", "description": "SKU ID." }, "warehouseId": { "type": "string", "description": "Warehouse ID." }, "quantity": { "type": "integer", "description": "SKU quantity." }, "isUnlimitedQuantity": { "type": "boolean", "description": "Indicates whether the SKU's availability is unlimited (\"unlimited inventory\")." }, "totalReservedQuantity": { "type": "integer", "description": "Total reserved quantity of the SKU." }, "dispatchedReservationsQuantity": { "type": "integer", "description": "Dispatched reservations quantity." }, "availableQuantity": { "type": "integer", "description": "Available quantity." } } } }, "example": [ { "skuId": "1", "warehouseId": "1", "quantity": 2147483647, "isUnlimitedQuantity": true, "totalReservedQuantity": 0, "dispatchedReservationsQuantity": 0, "availableQuantity": 2147483647 } ] } } } } } }, "/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots": { "get": { "tags": [ "Inventory" ], "summary": "List supply lots", "description": "Lists supply lots of a SKU in a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "GetSupplyLots", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "skuId", "in": "path", "description": "SKU ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "36" } }, { "name": "warehouseId", "in": "path", "description": "ID of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) where the SKU is located.", "required": true, "style": "simple", "schema": { "type": "string", "example": "whs15hs6c" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Supply lot details.", "properties": { "skuId": { "type": "string", "description": "SKU ID related to the supply lot." }, "warehouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID where the SKU supply lot will arrive." }, "dockId": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." }, "totalQuantity": { "type": "integer", "description": "Total quantity scheduled for the SKU in the supply lot." }, "reservedQuantity": { "type": "integer", "description": "Total [reserved quantity](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) scheduled for the SKU in the supply lot." }, "availableQuantity": { "type": "integer", "description": "Available quantity scheduled for the SKU in the supply lot." }, "isUnlimited": { "type": "boolean", "description": "Indicates if the unlimited inventory is activated so the SKU availability for sales is unlimited (`true`), or not (`false`)." }, "salesChannel": { "type": "array", "description": "List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated with the supply lot.", "items": { "type": "string", "description": "Sales channel (trade policy) ID." } }, "deliveryChannels": { "type": "array", "description": "List of delivery channels type associated with the supply lot.", "items": { "type": "string", "description": "Delivery channel type.", "enum": [ "delivery", "pickup" ] } }, "timeToRefill": { "type": "string", "description": "Time to refill in the format `HH:MM:SS`.", "nullable": true }, "dateOfSupplyUtc": { "type": "string", "description": "Date and time scheduled for the SKU from the warehouse to have quantity and availability for sales again. The format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "supplyLotId": { "type": "string", "description": "Supply lot ID." }, "keepSellingAfterExpiration": { "type": "boolean", "description": "Defines if the SKU from the warehouse should be available for sales after running _out-of-stock_ (`true`), or not (`false`)." }, "transfer": { "type": "string", "description": "Transfer system.", "nullable": true }, "leadTime": { "type": "string", "description": "[Lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) is an optional time configuration for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and is considered for shipping date calculation. The format is `DD.HH:MM:SS`.", "nullable": true } } } }, "example": [ { "skuId": "12", "warehouseId": "124816", "dockId": "1839", "totalQuantity": 0, "reservedQuantity": 0, "availableQuantity": 0, "isUnlimited": false, "salesChannel": [ "1" ], "deliveryChannels": [ "delivery" ], "timeToRefill": "12:50:00", "dateOfSupplyUtc": "2025-10-18T00:00:00+00:00", "supplyLotId": "supplyId1", "keepSellingAfterExpiration": true, "transfer": null, "leadTime": "10.00:00:00" } ] } } } } } }, "/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}": { "put": { "tags": [ "Inventory" ], "summary": "Save supply lot", "description": "Creates a new supply lot, which allows you to sell a SKU that is currently _out-of-stock_ in your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) and unavailable for sales. Creating a supply lot is useful when you know the date of when the SKU will have quantity and availability for sales again.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "SaveSupplyLot", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "skuId", "in": "path", "description": "SKU ID being scheduled for availability for sales.", "required": true, "style": "simple", "schema": { "type": "string", "example": "36" } }, { "name": "warehouseId", "in": "path", "description": "ID of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) where the SKU will arrive.", "required": true, "style": "simple", "schema": { "type": "string", "example": "whs15hs6c" } }, { "name": "supplyLotId", "in": "path", "description": "ID of the supply lot of the SKU availability scheduling.", "required": true, "style": "simple", "schema": { "type": "string", "example": "7100-1023-04" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "quantity", "dateOfSupplyUtc" ], "type": "object", "properties": { "quantity": { "type": "integer", "description": "Supply lot quantity for a SKU from a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).", "example": 1200 }, "dateOfSupplyUtc": { "type": "string", "description": "Date and time of when the SKU from the warehouse will have quantity and availability for sales again. The format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. Since it is a prevision, this field must be a future date.", "example": "2025-02-25T09:00:00+00:00" }, "keepSellingAfterExpiration": { "type": "boolean", "description": "Defines if the SKU from the warehouse should be available for sales after running _out-of-stock_ (`true`), or not (`false`).", "example": true } } } } } }, "responses": { "204": { "description": "No Content" } } } }, "/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}/transfer": { "post": { "tags": [ "Inventory" ], "summary": "Transfer supply lot", "description": "Transfers a SKU from a supply lot to the currently available inventory.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "TransferSupplyLot", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "skuId", "in": "path", "description": "ID of the SKU.", "required": true, "style": "simple", "schema": { "type": "string", "example": "36" } }, { "name": "warehouseId", "in": "path", "description": "ID of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) where the SKU is located.", "required": true, "style": "simple", "schema": { "type": "string", "example": "whs15hs6c" } }, { "name": "supplyLotId", "in": "path", "description": "ID of the supply lot in which the SKU is currently located and from where it will be transfered.", "required": true, "style": "simple", "schema": { "type": "string", "example": "7100-1023-04" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/logistics/pvt/configuration/holidays/{holidayId}": { "put": { "tags": [ "Holidays" ], "summary": "Create or update holiday", "description": "Creates or updates a [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk), searching by holiday ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Create/UpdateHoliday", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "holidayId", "in": "path", "description": "[Holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "christmas2025" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "startDate" ], "type": "object", "description": "Holiday information.", "properties": { "name": { "type": "string", "description": "[Holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) ID.", "example": "Christmas" }, "startDate": { "type": "string", "description": "Holiday starting date, in the format `YYYY-MM-DD`.", "example": "2024-12-25" } } } } } }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Holidays" ], "summary": "List holiday by ID", "description": "Lists information about a [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk), searching by holiday ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "HolidayById", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "holidayId", "in": "path", "description": "[Holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "christmas2025" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Holidays" ], "summary": "Delete holiday", "description": "Deletes a [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) set up in your store, searching by holiday ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Holiday", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "holidayId", "in": "path", "description": "[Holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "christmas2025" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/configuration/holidays": { "get": { "tags": [ "Holidays" ], "summary": "List all holidays", "description": "Lists information about all [holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured on your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "AllHolidays", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/inventory/reservations": { "post": { "tags": [ "Reservations" ], "summary": "Create reservation", "description": "Creates a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "CreateReservation", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "salesChannel", "lockId", "autorizationExpirationTTL", "deliveryItemOptions" ], "type": "object", "description": "Reservation sales channel information.", "properties": { "salesChannel": { "type": "string", "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation.", "example": "1" }, "lockId": { "type": "string", "description": "[Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) ID.", "example": null, "nullable": true }, "autorizationExpirationTTL": { "type": "string", "description": "Duration before expiring the reservation, in the format `DD.HH:MM:SS`.", "example": "10.00:00:00" }, "deliveryItemOptions": { "type": "array", "description": "Array with information about reserved items.", "items": { "required": [ "item", "slaType", "slaTypeName", "listPrice", "promotionalPrice", "transitTime", "dockTime", "timeToDockPlusDockTime", "aditionalTimeBlockedDays", "totalTime", "deliveryWindows", "wareHouseId", "dockId", "location" ], "type": "object", "description": "Reserved items information.", "properties": { "item": { "required": [ "id", "quantity", "kitItem", "price", "additionalHandlingTime", "dimension" ], "type": "object", "description": "Reserved item object.", "properties": { "id": { "type": "string", "description": "SKU ID.", "example": "29" }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity of items.", "example": 1 }, "kitItem": { "type": "array", "items": { "type": "string", "description": "Kit SKU ID.", "example": null, "nullable": true }, "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items information, when applicable." }, "price": { "type": "number", "description": "Item price.", "example": 14128.9 }, "modal": { "type": "string", "description": "Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight.", "enum": [ "CHEMICALS", "ELECTRONICS", "FURNITURE", "GLASS", "LIQUID", "MATTRESSES", "REFRIGERATED", "TIRES", "WHITE_GOODS", "FIREARMS" ], "example": "FURNITURE", "nullable": true }, "additionalHandlingTime": { "type": "string", "description": "Additional handling time in the format `DD.HH:MM:SS`.", "example": "00:00:00" }, "dimension": { "required": [ "weight", "height", "width", "length" ], "type": "object", "description": "Item dimensions.", "properties": { "weight": { "type": "number", "description": "Item weight.", "example": 186.3700 }, "height": { "type": "number", "description": "Item height.", "example": 23.5000 }, "width": { "type": "number", "description": "Item width.", "example": 165.0000 }, "length": { "type": "number", "description": "Item length.", "example": 67.5000 } } } } }, "slaType": { "type": "string", "description": "SLA (Service Level Agreement) type.", "example": "delivery" }, "slaTypeName": { "type": "string", "description": "SLA name.", "example": "Normal delivery" }, "listPrice": { "type": "number", "description": "List price.", "example": 10.5 }, "promotionalPrice": { "type": "number", "description": "Promotion price.", "example": 10.5 }, "transitTime": { "type": "string", "description": "Transit time in the format `DD.HH:MM:SS`.", "example": "2.00:00:00" }, "dockTime": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.", "example": "00:00:00" }, "timeToDockPlusDockTime": { "type": "string", "description": "Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`.", "example": "1.00:00:00" }, "aditionalTimeBlockedDays": { "type": "string", "description": "Additional time blocked in the format `DD.HH:MM:SS`.", "example": "1.00:00:00" }, "totalTime": { "type": "string", "description": "SLA total time in the format `DD.HH:MM:SS`.", "example": "3.00:00:00" }, "deliveryWindows": { "type": "array", "items": { "type": "object", "description": "Delivery window details.", "properties": { "startDateUtc": { "type": "string", "description": "Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.", "example": "2024-02-25T09:00:00+00:00" }, "endDateUtc": { "type": "string", "description": "Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.", "example": "2024-02-25T12:00:00+00:00" }, "listPrice": { "type": "string", "description": "List price.", "example": "0.0" } } }, "description": "[Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz).", "nullable": true }, "wareHouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.", "example": "1937054", "nullable": true }, "dockId": { "type": "string", "description": "Loading dock ID.", "example": "1a8bce3" }, "location": { "required": [ "zipCode", "country", "inStore" ], "type": "object", "description": "Shipping location details.", "properties": { "zipCode": { "type": "string", "description": "Shipping address postal code.", "example": "22220070" }, "country": { "type": "string", "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.", "example": "BRA" }, "inStore": { "required": [ "IsCheckedIn", "StoreId" ], "type": "object", "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).", "properties": { "IsCheckedIn": { "type": "boolean", "description": "This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not.", "example": false }, "StoreId": { "type": "string", "description": "ID of purchases made in the GoCommerce context.", "example": "180082", "nullable": true } } } } } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "LastUpdateDateUtc": { "type": "string", "description": "Last update date and time in the format [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "SalesChannel": { "type": "string", "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation." }, "LockId": { "type": "string", "description": "Reservation ID." }, "ReservationDateUtc": { "type": "string", "description": "Reservation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "MaximumConfirmationDateUtc": { "type": "string", "description": "Maximum confirmation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "Status": { "type": "integer", "format": "int32", "description": "Reservation status, meaning:\r\n\r\n- `0`: `NotCommitted`\r\n\r\n- `1`: `Authorized`\r\n\r\n- `2`: `Confirmed`\r\n\r\n- `3`: `Canceled_AbortedCommitted`\r\n\r\n- `4`: `Canceled_AuthorizationExpired`\r\n\r\n- `5`: `Canceled_Manually`" }, "SlaRequest": { "type": "array", "description": "SLA (Service Level Agreement) request information.", "items": { "type": "object", "description": "SLA details.", "properties": { "item": { "type": "object", "description": "Information about the reserved item.", "properties": { "id": { "type": "string", "description": "SKU ID." }, "groupItemId": { "type": "string", "description": "Group item ID.", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "description": "Item quantity." }, "price": { "type": "number", "description": "Item price." }, "modal": { "type": "string", "description": "Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight.", "enum": [ "CHEMICALS", "ELECTRONICS", "FURNITURE", "GLASS", "LIQUID", "MATTRESSES", "REFRIGERATED", "TIRES", "WHITE_GOODS", "FIREARMS" ], "nullable": true }, "additionalHandlingTime": { "type": "string", "description": "Additional handling time in the format `DD.HH:MM:SS`." }, "dimension": { "type": "object", "description": "Item dimensions.", "properties": { "weight": { "type": "number", "description": "Item weight." }, "height": { "type": "number", "description": "Item height." }, "width": { "type": "number", "description": "Item width." }, "length": { "type": "number", "description": "Item length." }, "maxSumDimension": { "type": "number", "description": "Maximum sum of dimensions." } } }, "kitItem": { "type": "array", "nullable": true, "items": { "type": "string", "description": "SKU ID." }, "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information." }, "unlimitedQuantity": { "type": "boolean", "description": "When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock." } } }, "slaType": { "type": "string", "description": "SLA (Service Level Agreement) type." }, "slaTypeName": { "type": "string", "description": "SLA name." }, "freightTableName": { "type": "string", "description": "[Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name." }, "freightTableId": { "type": "string", "description": "Shipping rate template ID." }, "listPrice": { "type": "number", "description": "List price." }, "promotionalPrice": { "type": "number", "description": "Promotion price." }, "transitTime": { "type": "string", "description": "Transit time in the format `DD.HH:MM:SS`." }, "dockTime": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`." }, "timeToDockPlusDockTime": { "type": "string", "description": "Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`." }, "totalTime": { "type": "string", "description": "SLA total time in the format `DD.HH:MM:SS`." }, "deliveryWindows": { "type": "object", "items": { "type": "object", "description": "Delivery window details.", "properties": { "startDateUtc": { "type": "string", "description": "Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "endDateUtc": { "type": "string", "description": "Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "listPrice": { "type": "number", "description": "List price." } } }, "description": "[Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz).", "nullable": true }, "wareHouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." }, "dockId": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." }, "wmsEndPoint": { "type": "string", "description": "Warehouse Management System (WMS) fulfillment endpoint.", "nullable": true }, "location": { "type": "object", "description": "Shipping location information.", "properties": { "zipCode": { "type": "string", "description": "Shipping address postal code." }, "country": { "type": "string", "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "deliveryPointId": { "type": "string", "description": "Delivery point ID.", "nullable": true }, "point": { "type": "array", "description": "Location delivery point coordinates.", "items": { "type": "number", "description": "Location coordinates, first longitude, then latitude." }, "nullable": true }, "inStore": { "type": "object", "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).", "properties": { "IsCheckedIn": { "type": "boolean", "description": "This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not." }, "StoreId": { "type": "string", "description": "ID of purchases made in the GoCommerce context.", "nullable": true } } } } }, "pickupStoreInfo": { "type": "string", "description": "Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", "nullable": true } } } }, "PickupPointItemOptions": { "type": "string", "description": "(Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) item options.", "nullable": true }, "CanceledDateUtc": { "type": "string", "description": "Reservation canceled date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "AuthorizedDateUtc": { "type": "string", "description": "Authorized date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "ConfirmedDateUtc": { "type": "string", "description": "Confirmed date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "Errors": { "type": "array", "description": "Errors details, if there are any.", "items": { "type": "string", "description": "Error message.", "nullable": true }, "nullable": true }, "IsSucess": { "type": "boolean", "description": "Defines if the reservation was successful (`true`) or not (`false`)." } } }, "example": { "LastUpdateDateUtc": "2024-04-15T19:59:20.0397988+00:00", "SalesChannel": "1", "LockId": "3bfe679d-c0a8-475a-b315-706f84a9deb4", "ReservationDateUtc": "2024-04-15T19:59:20.0397988+00:00", "MaximumConfirmationDateUtc": "2024-04-15T20:09:20.0397988+00:00", "Status": 1, "SlaRequest": [ { "item": { "id": "29", "groupItemId": null, "quantity": 1, "price": 0, "modal": "FURNITURE", "additionalHandlingTime": "00:00:00", "dimension": { "weight": 186.3700, "height": 23.5000, "width": 165.0000, "length": 67.5000, "maxSumDimension": 300.000 }, "kitItem": [], "unlimitedQuantity": false }, "slaType": "delivery", "slaTypeName": "Normal delivery", "freightTableName": "Correios PAC", "freightTableId": "11cc4b6", "listPrice": 10.5, "promotionalPrice": 10.5, "transitTime": "2.00:00:00", "dockTime": "00:00:00", "timeToDockPlusDockTime": "1.00:00:00", "totalTime": "3.00:00:00", "deliveryWindows": { "startDateUtc": "2024-02-25T09:00:00+00:00", "endDateUtc": "2024-02-25T12:00:00+00:00", "listPrice": 0.0 }, "wareHouseId": "1937054", "dockId": "1a8bce3", "wmsEndPoint": null, "location": { "zipCode": "22220070", "country": "BRA", "deliveryPointId": null, "point": null, "inStore": { "IsCheckedIn": false, "StoreId": "180082" } }, "pickupStoreInfo": null } ], "PickupPointItemOptions": null, "CanceledDateUtc": "0001-01-01T00:00:00+00:00", "AuthorizedDateUtc": "2024-04-15T19:59:20.0397988+00:00", "ConfirmedDateUtc": "0001-01-01T00:00:00+00:00", "Errors": [], "IsSucess": true } } } } } } }, "/api/logistics/pvt/inventory/reservations/{reservationId}": { "get": { "tags": [ "Reservations" ], "summary": "List reservation by ID", "description": "Lists information about a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "ReservationById", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "reservationId", "in": "path", "description": "[Reservation](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "00-1336411707838-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "LastUpdateDateUtc": { "type": "string", "description": "Last update date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "SalesChannel": { "type": "string", "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation." }, "LockId": { "type": "string", "description": "Reservation ID." }, "ReservationDateUtc": { "type": "string", "description": "Reservation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "MaximumConfirmationDateUtc": { "type": "string", "description": "Maximum confirmation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "Status": { "type": "integer", "format": "int32", "description": "Reservation status, meaning:\r\n\r\n- `0`: `NotCommitted`\r\n\r\n- `1`: `Authorized`\r\n\r\n- `2`: `Confirmed`\r\n\r\n- `3`: `Canceled_AbortedCommitted`\r\n\r\n- `4`: `Canceled_AuthorizationExpired`\r\n\r\n- `5`: `Canceled_Manually`" }, "SlaRequest": { "type": "array", "description": "SLA (Service Level Agreement) request information.", "items": { "type": "object", "description": "SLA details.", "properties": { "item": { "type": "object", "description": "Information about the reserved item.", "properties": { "id": { "type": "string", "description": "SKU ID." }, "groupItemId": { "type": "string", "description": "Group item ID.", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "description": "Item quantity." }, "price": { "type": "number", "description": "Item price." }, "modal": { "type": "string", "description": "Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight.", "enum": [ "CHEMICALS", "ELECTRONICS", "FURNITURE", "GLASS", "LIQUID", "MATTRESSES", "REFRIGERATED", "TIRES", "WHITE_GOODS", "FIREARMS" ], "nullable": true }, "additionalHandlingTime": { "type": "string", "description": "Additional handling time in the format `DD.HH:MM:SS`." }, "dimension": { "type": "object", "description": "Item dimensions.", "properties": { "weight": { "type": "number", "description": "Item weight." }, "height": { "type": "number", "description": "Item height." }, "width": { "type": "number", "description": "Item width." }, "length": { "type": "number", "description": "Item length." }, "maxSumDimension": { "type": "number", "description": "Maximum sum of dimensions." } } }, "kitItem": { "type": "array", "nullable": true, "items": { "type": "string", "description": "Kit SKU ID." }, "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information." }, "unlimitedQuantity": { "type": "boolean", "description": "When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale — no matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock." }, "dockId": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." }, "wareHouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." }, "provider": { "type": "string", "description": "SLA request provider.", "nullable": true } } }, "slaType": { "type": "string", "description": "SLA (Service Level Agreement) type." }, "slaTypeName": { "type": "string", "description": "SLA name." }, "freightTableName": { "type": "string", "description": "[Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name." }, "freightTableId": { "type": "string", "description": "Shipping rate template ID." }, "listPrice": { "type": "number", "description": "List price." }, "promotionalPrice": { "type": "number", "description": "Promotion price." }, "timeToPresale": { "type": "string", "description": "Time to presale in the format `D.HH:MM:SS`." }, "transitTime": { "type": "string", "description": "Transit time in the format `DD.HH:MM:SS`." }, "dockTime": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`." }, "timeToDockPlusDockTime": { "type": "string", "description": "Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`." }, "totalTime": { "type": "string", "description": "SLA total time in the format `DD.HH:MM:SS`." }, "deliveryWindows": { "type": "object", "items": { "type": "object", "description": "Delivery window details.", "properties": { "startDateUtc": { "type": "string", "description": "Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "endDateUtc": { "type": "string", "description": "Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "listPrice": { "type": "number", "description": "List price." } } }, "description": "[Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz).", "nullable": true }, "wareHouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." }, "kitReservation": { "type": "string", "description": "Kit reservation.", "nullable": true }, "dockId": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." }, "wmsEndPoint": { "type": "string", "description": "Warehouse Management System (WMS) fulfillment endpoint.", "nullable": true }, "location": { "type": "object", "description": "Shipping location information.", "properties": { "zipCode": { "type": "string", "description": "Shipping address postal code." }, "country": { "type": "string", "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "point": { "type": "array", "description": "Location delivery point coordinates.", "items": { "type": "number", "description": "Location coordinates, first longitude, then latitude." }, "nullable": true }, "inStore": { "type": "object", "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).", "properties": { "IsCheckedIn": { "type": "boolean", "description": "This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not." }, "StoreId": { "type": "string", "description": "ID of purchases made in the GoCommerce context.", "nullable": true } } } } }, "pickupStoreInfo": { "type": "string", "description": "Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", "nullable": true }, "deliveryOnWeekends": { "type": "boolean", "description": "Defines if the delivery on weekends configuration is active (`true`) or not (`false`).", "nullable": true }, "weekendAndHolidays": { "type": "object", "description": "Delivery on weekends and holidays information.", "properties": { "saturday": { "type": "boolean", "description": "Defines if the delivery on Saturday configuration is active (`true`) or not (`false`)." }, "sunday": { "type": "boolean", "description": "Defines if the delivery on Sunday configuration is active (`true`) or not (`false`)." }, "holiday": { "type": "boolean", "description": "Defines if the delivery on [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configuration is active (`true`) or not (`false`)." } } }, "estimateDate": { "type": "string", "description": "Delivery estimate date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "deliveryChannel": { "type": "string", "description": "Delivery channel." }, "totalTimePlusCarrierSchedule": { "type": "string", "description": "Total shipping time plus carrier schedule, in the format `DD.HH:MM:SS`." }, "polygonName": { "type": "string", "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) name." }, "distanceLevel": { "type": "string", "description": "SLA distance level.", "nullable": true }, "accountCarrier": { "type": "string", "description": "Account carrier." }, "dateOfSupplyUtc": { "type": "string", "description": "Supply date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.", "nullable": true }, "supplyLotId": { "type": "string", "description": "Supply lot ID.", "nullable": true }, "isExternal": { "type": "boolean", "description": "Defines if the SLA request is external (`true`) or not (`false`)." } } } }, "CanceledDateUtc": { "type": "string", "description": "Reservation canceled date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "AuthorizedDateUtc": { "type": "string", "description": "Authorized date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "ConfirmedDateUtc": { "type": "string", "description": "Confirmed date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "Errors": { "type": "array", "description": "Error details, if there are any.", "items": { "type": "string", "description": "Error message.", "nullable": true }, "nullable": true }, "IsSucess": { "type": "boolean", "description": "Defines if the reservation was successful (`true`) or not (`false`)." } } }, "example": { "LastUpdateDateUtc": "2024-05-01T17:14:51.5898912+00:00", "SalesChannel": "1", "LockId": "00-1336411707838-01", "ReservationDateUtc": "2024-05-01T17:14:40.4900134+00:00", "MaximumConfirmationDateUtc": "2024-06-13T17:14:40.4900134+00:00", "Status": 2, "SlaRequest": [ { "item": { "id": "229", "groupItemId": null, "quantity": 1, "price": 5.0, "modal": "FURNITURE", "additionalHandlingTime": "00:00:00", "dimension": { "weight": 186.3700, "height": 23.5000, "width": 165.0000, "length": 67.5000, "maxSumDimension": 300.000 }, "kitItem": [], "unlimitedQuantity": false, "dockId": "dk_temp", "warehouseId": "wh_temp", "provider": null }, "slaType": "delivery", "slaTypeName": "Normal delivery", "freightTableName": "Correios PAC", "freightTableId": "11cc4b6", "listPrice": 10.35, "promotionalPrice": 10.35, "timeToPresale": "00:00:00", "transitTime": "1.00:00:00", "dockTime": "00:00:00", "timeToDockPlusDockTime": "00:00:00", "totalTime": "1.00:00:00", "deliveryWindows": { "startDateUtc": "2024-02-25T09:00:00+00:00", "endDateUtc": "2024-02-25T12:00:00+00:00", "listPrice": 0.0 }, "wareHouseId": "wh_temp", "kitReservation": null, "dockId": "dk_temp", "wmsEndPoint": null, "location": { "zipCode": "58039210", "country": "BRA", "point": [ -34.829391479492188, -7.1152286529541016 ], "inStore": { "isCheckedIn": false, "storeId": "180082" } }, "pickupStoreInfo": null, "deliveryOnWeekends": true, "weekendAndHolidays": { "saturday": true, "sunday": true, "holiday": true }, "estimateDate": "2024-05-02T17:14:51.5742729+00:00", "deliveryChannel": "delivery", "totalTimePlusCarrierSchedule": "1.00:00:00", "polygonName": "centerlRio", "distanceLevel": null, "accountCarrier": "recorrenciaqa", "dateOfSupplyUtc": null, "supplyLotId": null, "isExternal": false } ], "CanceledDateUtc": "0001-01-01T00:00:00+00:00", "AuthorizedDateUtc": "2024-05-01T17:14:40.4900134+00:00", "ConfirmedDateUtc": "2024-05-01T17:14:51.5898912+00:00", "Errors": [], "IsSucess": true } } } } } } }, "/api/logistics/pvt/inventory/reservations/{reservationId}/confirm": { "post": { "tags": [ "Reservations" ], "summary": "Confirm reservation", "description": "Confirms a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "ConfirmReservation", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "reservationId", "in": "path", "description": "[Reservation](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "00-1336411707838-01" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/inventory/reservations/{reservationId}/acknowledge": { "post": { "tags": [ "Reservations" ], "summary": "Acknowledgment reservation", "description": "Acknowledges a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "AcknowledgmentReservation", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "reservationId", "in": "path", "description": "[Reservation](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "00-1336411707838-01" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/inventory/reservations/{reservationId}/cancel": { "post": { "tags": [ "Reservations" ], "summary": "Cancel reservation", "description": "Cancels a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "CancelReservation", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "reservationId", "in": "path", "description": "[Reservation](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "00-1336411707838-01" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/inventory/reservations/{warehouseId}/{skuId}": { "get": { "tags": [ "Reservations" ], "summary": "List reservation by warehouse and SKU", "description": "Lists information about [reservations](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID and SKU ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "ReservationbyWarehouseandSku", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "warehouseId", "in": "path", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "whs15hs6c" } }, { "name": "skuId", "in": "path", "description": "SKU ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "36" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/logistics/pvt/shipping/calculate": { "post": { "tags": [ "SLA" ], "summary": "Calculate SLA", "description": "Checkout uses this endpoint to calculate a Service Level Agreement (SLA), a contract between the store and a customer about their order fulfillment conditions, such as the shipping estimated date.\r\n\r\nThe calculation of the estimated date considers the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) and [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the order.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "CalculateSLA", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Shipping conditions to calculate the Service Level Agreement (SLA).", "required": [ "items", "location" ], "properties": { "items": { "type": "array", "description": "Items' shipping conditions to calculate the Service Level Agreement (SLA).", "items": { "type": "object", "description": "Item's information.", "required": [ "id", "quantity", "dimension" ], "properties": { "id": { "type": "string", "description": "SKU ID.", "example": "1" }, "quantity": { "type": "integer", "format": "int32", "description": "SKU quantity.", "example": 1 }, "price": { "type": "number", "description": "Item price.", "example": 14128.9, "nullable": true }, "modal": { "type": "string", "description": "[Modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125) is a special freight.", "enum": [ "CHEMICALS", "ELECTRONICS", "FURNITURE", "GLASS", "LIQUID", "MATTRESSES", "REFRIGERATED", "TIRES", "WHITE_GOODS", "FIREARMS" ], "example": "FURNITURE", "nullable": true }, "additionalHandlingTime": { "type": "string", "description": "Additional handling time in the format `DD.HH:MM:SS`.", "example": "00:00:00" }, "dimension": { "type": "object", "description": "Item dimensions.", "properties": { "weight": { "type": "number", "description": "Item weight.", "example": 86.3700 }, "height": { "type": "number", "description": "Item height.", "example": 23.5000 }, "width": { "type": "number", "description": "Item width.", "example": 65.0000 }, "length": { "type": "number", "description": "Item length.", "example": 67.5000 }, "maxSumDimension": { "type": "number", "description": "Maximum sum of dimensions.", "example": 243.9000 } } }, "kitItem": { "type": "array", "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information.", "items": { "type": "object", "description": "Kit item object.", "required": [ "id", "quantity", "dimension" ], "properties": { "id": { "type": "string", "description": "Kit SKU ID.", "example": "2" }, "groupItemId": { "type": "string", "description": "Kit group item ID.", "example": null, "nullable": true }, "kitItem": { "type": "array", "description": "Kit item list.", "items": { "type": "string", "description": "Kit items' IDs.", "example": "1" }, "nullable": true }, "quantity": { "type": "integer", "format": "int32", "description": "Kit SKU quantity.", "example": 1 }, "price": { "type": "number", "description": "Kit SKU price.", "example": 1.0 }, "additionalHandlingTime": { "type": "string", "description": "Kit item additional handling time in the format `DD.HH:MM:SS`.", "example": "00:00:00" }, "dimension": { "type": "object", "description": "Kit item dimensions.", "properties": { "weight": { "type": "number", "description": "Kit item weight.", "example": 1.0 }, "height": { "type": "number", "description": "Kit item height.", "example": 1.0 }, "width": { "type": "number", "description": "Kit item width.", "example": 1.0 }, "length": { "type": "number", "description": "Kit item length.", "example": 1.0 }, "maxSumDimension": { "type": "number", "description": "Maximum sum of dimensions.", "example": 5.0 } } } } }, "nullable": true }, "dockId": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.", "example": "1a8bce3", "nullable": true }, "wareHouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.", "example": "1937054", "nullable": true } } } }, "location": { "type": "object", "description": "Shipping location information.", "required": [ "zipCode", "country" ], "properties": { "zipCode": { "type": "string", "description": "Shipping adress postal code.", "example": "22780084" }, "country": { "type": "string", "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.", "example": "BRA" }, "point": { "type": "array", "description": "Shipping address coordinates, first longitude then latitude.", "items": { "type": "number", "description": "Longitude or latitude.", "example": -43.231716156005859 }, "example": [ -43.231716156005859, -22.990713500405295 ] }, "inStore": { "type": "object", "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).", "properties": { "IsCheckedIn": { "type": "boolean", "description": "This field is set as `true` when the order is placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it is not.", "example": false }, "StoreId": { "type": "string", "description": "ID of purchases made in the GoCommerce context.", "example": "180082", "nullable": true } } } } }, "salesChannel": { "type": "string", "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the SLA calculation.", "example": "1" }, "deliveryChannel": { "type": "string", "description": "Defines if the shipping type is `delivery` or `pickup`.", "example": "delivery", "nullable": true } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "description": "List of Service Level Agreements (SLA).", "items": { "type": "object", "description": "Service Level Agreements (SLA) conditions.", "properties": { "itemId": { "type": "string", "description": "SKU ID." }, "quantity": { "type": "integer", "format": "int32", "description": "SKU quantity." }, "kitItem": { "type": "array", "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items' information.", "items": { "type": "object", "description": "Kit item object.", "properties": { "id": { "type": "string", "description": "Kit SKU ID." }, "quantity": { "type": "integer", "description": "Kit SKU quantity." }, "warehouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID where the kit SKU is stored." }, "supplyLotId": { "type": "string", "description": "Kit SKU supply lot ID.", "nullable": true } } } }, "availabilityQuantity": { "type": "integer", "format": "int32", "description": "SKU quantity available for sales. [Reserved](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) items do not count." }, "salesChannel": { "type": "string", "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the SLA calculation." }, "slaType": { "type": "string", "description": "Service Level Agreement (SLA) type." }, "slaTypeName": { "type": "string", "description": "Service Level Agreement (SLA) name." }, "freightTableName": { "type": "string", "description": "[Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name." }, "freightTableId": { "type": "string", "description": "Shipping rate template ID." }, "listPrice": { "type": "number", "description": "SKU list price." }, "transitTime": { "type": "string", "description": "Transit time in the format `DD.HH:MM:SS`." }, "dockTime": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`." }, "timeToDockPlusDockTime": { "type": "string", "description": "Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`." }, "aditionalTimeBlockedDays": { "type": "string", "description": "Additional time blocked in the format `DD.HH:MM:SS`." }, "leadTime": { "type": "string", "description": "[Lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) is an optional time configuration for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and is considered for shipping date calculation. The format is `DD.HH:MM:SS`." }, "totalTime": { "type": "string", "description": "SLA total time in the format `DD.HH:MM:SS`." }, "deliveryWindows": { "type": "array", "description": "[Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) configurations.", "items": { "type": "object", "description": "Delivery window details.", "properties": { "startDateUtc": { "type": "string", "description": "Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "endDateUtc": { "type": "string", "description": "Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "listPrice": { "type": "number", "description": "List price." } } } }, "wareHouseId": { "type": "string", "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID." }, "dockId": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." }, "location": { "type": "object", "description": "Shipping location information.", "properties": { "zipCode": { "type": "string", "description": "Shipping adress postal code." }, "country": { "type": "string", "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "point": { "type": "array", "description": "Shipping address coordinates, first longitude then latitude.", "items": { "type": "number", "description": "Longitude or latitude." }, "nullable": true }, "inStore": { "type": "object", "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).", "properties": { "isCheckedIn": { "type": "boolean", "description": "This field is set as `true` when the order is placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it is not." }, "storeId": { "type": "string", "description": "ID of purchases made in the GoCommerce context.", "nullable": true } } } } }, "deliveryOnWeekends": { "type": "boolean", "description": "Defines if the delivery on weekends configuration is active (`true`) or inactive (`false`)." }, "weekendAndHolidays": { "type": "object", "description": "Delivery on weekends and holidays information.", "properties": { "saturday": { "type": "boolean", "description": "Defines if the delivery on Saturday configuration is active (`true`) or inactive (`false`)." }, "sunday": { "type": "boolean", "description": "Defines if the delivery on Sunday configuration is active (`true`) or inactive (`false`)." }, "holiday": { "type": "boolean", "description": "Defines if the delivery on [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configuration is active (`true`) or inactive (`false`)." } }, "nullable": true }, "carrierSchedule": { "type": "array", "description": "Schedule sent by the carrier.", "items": { "type": "object", "description": "Carrier schedule object.", "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week, from `0` (Sunday) to `6` (Saturday).", "enum": [ 0, 1, 2, 3, 4, 5, 6 ] }, "timeLimit": { "type": "string", "description": "Time limit." } } } }, "totalTimePlusCarrierSchedule": { "type": "string", "description": "Total shipping time plus carrier schedule, in the format `DD.HH:MM:SS`." }, "restrictedFreight": { "type": "array", "description": "List of postal codes where the delivery is restricted for the carrier.", "items": { "type": "string", "description": "Restricted freight postal code.", "nullable": true }, "nullable": true }, "coordinates": { "type": "array", "description": "Shipping address geolocation coordinates, first longitude then latitude.", "nullable": true, "items": { "type": "number", "description": "Longitude or latitude.", "nullable": true } }, "pickupStoreInfo": { "type": "object", "description": "Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", "deprecated": true, "properties": { "isPickupStore": { "type": "boolean", "description": "Defines if the shipping type was pickup (`true`) or not (`false`).", "nullable": true, "deprecated": true }, "storeId": { "type": "string", "description": "Store ID for stores that acted as pickup points.", "nullable": true, "deprecated": true }, "friendlyName": { "type": "string", "description": "Name of the pickup point displayed at checkout.", "nullable": true, "deprecated": true }, "address": { "type": "object", "description": "Pickup point address information.", "nullable": true, "deprecated": true, "properties": { "postalCode": { "type": "string", "description": "Pickup point address postal code.", "deprecated": true }, "country": { "type": "object", "description": "Information about the pickup point address country.", "deprecated": true, "properties": { "acronym": { "type": "string", "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.", "deprecated": true }, "name": { "type": "string", "description": "Country name of the pickup point address.", "deprecated": true } } }, "city": { "type": "string", "description": "Pickup point address city.", "deprecated": true }, "state": { "type": "string", "description": "Pickup point address state.", "deprecated": true }, "neighborhood": { "type": "string", "description": "Pickup point address neighborhood.", "deprecated": true }, "street": { "type": "string", "description": "Pickup point address street.", "deprecated": true }, "number": { "type": "string", "description": "Pickup point address number.", "deprecated": true }, "complement": { "type": "string", "description": "Pickup point address complement.", "deprecated": true, "nullable": true }, "reference": { "type": "string", "description": "Pickup point address reference point.", "deprecated": true, "nullable": true }, "location": { "type": "object", "description": "Pickup point address geolocation coordinates.", "deprecated": true, "properties": { "latitude": { "type": "number", "description": "Latitude coordinate.", "deprecated": true }, "longitude": { "type": "number", "description": "Longitude coordinate.", "deprecated": true } } } } }, "additionalInfo": { "type": "string", "description": "Additional information about the delivery or the pickup point.", "nullable": true, "deprecated": true }, "dockId": { "type": "string", "description": "ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID.", "nullable": true, "deprecated": true }, "distance": { "type": "number", "description": "Distance in kilometers between the pickup point and the customer's address, measured as a straight line.", "nullable": true, "deprecated": true }, "businessHours": { "type": "string", "description": "Pickup point business hours configurations.", "nullable": true, "deprecated": true }, "pickupHolidays": { "type": "string", "description": "Holiday's configurations applicable to the pickup point.", "nullable": true, "deprecated": true }, "sellerId": { "type": "string", "description": "Seller ID.", "nullable": true, "deprecated": true }, "isThirdPartyPickup": { "type": "boolean", "description": "Defines if the pickup was third party (`true`) or not (`false`).", "deprecated": true } } }, "timeToPresale": { "type": "string", "description": "Time to presale in the format `DD.HH:MM:SS`." }, "deliveryChannel": { "type": "string", "description": "Defines if the shipping type is `delivery` or `pickup`." }, "availabilityQuantityByDeliveryChannel": { "type": "integer", "description": "Availability and quantity by the given delivery channel." }, "polygonName": { "type": "string", "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID (same as the polygon name)." }, "distanceLevel": { "type": "string", "description": "SLA distance level." }, "accountCarrier": { "type": "string", "description": "Account carrier." }, "carrierBusinessHours": { "type": "array", "description": "Carrier business hours configurations for the week.", "items": { "type": "object", "description": "Carrier business hours configurations for a day of the week.", "properties": { "openingTime": { "type": "string", "description": "Carrier opening time in `HH:MM:SS` format." }, "closingTime": { "type": "string", "description": "Carrier closing time in `HH:MM:SS` format." }, "dayOfWeek": { "type": "integer", "description": "Day of the week, from `0` (Sunday) to `6` (Saturday).", "enum": [ 0, 1, 2, 3, 4, 5, 6 ] } } } }, "provider": { "type": "string", "description": "Provider system.", "nullable": true }, "dateOfSupplyUtc": { "type": "string", "description": "Supply date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.", "nullable": true }, "estimateDate": { "type": "string", "description": "Delivery estimate date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "supplyLotId": { "type": "string", "description": "Supply lot ID.", "nullable": true }, "isExternal": { "type": "boolean", "description": "Defines if the SLA request is external (`true`) or not (`false`)." } } } } }, "example": [ [ { "itemId": "1", "quantity": 2, "kitItem": [ { "id": "1", "quantity": 1, "warehouseId": "wh-01", "supplyLotId": "05-05-22" } ], "availabilityQuantity": 3062340, "salesChannel": "1", "slaType": "Normal delivery", "slaTypeName": "Normal delivery", "freightTableName": "ft-01", "freightTableId": "ft-01", "listPrice": 12.12, "transitTime": "2.00:00:00", "dockTime": "00:00:00", "timeToDockPlusDockTime": "7.00:00:00", "aditionalTimeBlockedDays": "00:00:00", "leadTime": "00:00:00", "totalTime": "9.00:00:00", "deliveryWindows": [ { "startDateUtc": "2024-07-25T00:00:00+00:00", "endDateUtc": "2024-07-25T23:59:59+00:00", "listPrice": 0.0 } ], "wareHouseId": "wh-01", "dockId": "dock-01", "location": { "zipCode": "01239000", "country": "BRA", "point": null, "inStore": { "isCheckedIn": false, "storeId": null } }, "deliveryOnWeekends": true, "weekendAndHolidays": null, "carrierSchedule": [], "totalTimePlusCarrierSchedule": "9.00:00:00", "restrictedFreight": null, "coordinates": null, "pickupStoreInfo": { "isPickupStore": false, "storeId": null, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null, "distance": 0.0, "businessHours": null, "pickupHolidays": null, "sellerId": "storefashion", "isThirdPartyPickup": false }, "timeToPresale": "00:00:00", "deliveryChannel": "delivery", "availabilityQuantityByDeliveryChannel": 1012337, "polygonName": "ipanema_leblon", "distanceLevel": "", "accountCarrier": "storefashion", "carrierBusinessHours": [ { "dayOfWeek": 1, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 2, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 3, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 4, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 5, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 6, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 0, "openingTime": "00:00:00", "closingTime": "23:59:59" } ], "provider": null, "dateOfSupplyUtc": null, "estimateDate": "2024-07-24T15:39:00-03:00", "supplyLotId": "05-05-22", "isExternal": false }, { "itemId": "1", "quantity": 2, "kitItem": [ { "id": "1", "quantity": 1, "warehouseId": "wh8735n", "supplyLotId": null } ], "availabilityQuantity": 3062340, "salesChannel": "1", "slaType": "Capacity", "slaTypeName": "Capacity", "freightTableName": "Delivery Capacity11", "freightTableId": "168e017", "listPrice": 2.02, "transitTime": "00:01:00", "dockTime": "00:00:00", "timeToDockPlusDockTime": "00:00:00", "aditionalTimeBlockedDays": "00:00:00", "leadTime": "00:00:00", "totalTime": "00:01:00", "deliveryWindows": [ { "startDateUtc": "2024-07-16T00:00:00+00:00", "endDateUtc": "2024-07-16T23:59:59+00:00", "listPrice": 0.0 }, { "startDateUtc": "2024-07-16T09:00:00+00:00", "endDateUtc": "2024-07-16T10:59:59+00:00", "listPrice": 0.0 }, { "startDateUtc": "2024-07-17T00:00:00+00:00", "endDateUtc": "2024-07-17T23:59:59+00:00", "listPrice": 0.0 }, { "startDateUtc": "2024-07-17T09:00:00+00:00", "endDateUtc": "2024-07-17T10:59:59+00:00", "listPrice": 0.0 }, { "startDateUtc": "2024-07-18T00:00:00+00:00", "endDateUtc": "2024-07-18T23:59:59+00:00", "listPrice": 0.0 }, { "startDateUtc": "2024-07-18T09:00:00+00:00", "endDateUtc": "2024-07-18T10:59:59+00:00", "listPrice": 0.0 } ], "wareHouseId": "wh8735n", "dockId": "d89vnwe", "location": { "zipCode": "01239000", "country": "BRA", "point": null, "inStore": { "isCheckedIn": false, "storeId": null } }, "deliveryOnWeekends": true, "weekendAndHolidays": null, "carrierSchedule": [], "totalTimePlusCarrierSchedule": "00:01:00", "restrictedFreight": null, "coordinates": null, "pickupStoreInfo": { "isPickupStore": false, "storeId": null, "friendlyName": null, "address": null, "additionalInfo": null, "dockId": null, "distance": 0.0, "businessHours": null, "pickupHolidays": null, "sellerId": "logisticsqa", "isThirdPartyPickup": false }, "timeToPresale": "00:00:00", "deliveryChannel": "delivery", "availabilityQuantityByDeliveryChannel": 1012337, "polygonName": "central_rio", "distanceLevel": "", "accountCarrier": "logisticsqa", "carrierBusinessHours": [ { "dayOfWeek": 1, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 2, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 3, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 4, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 5, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 6, "openingTime": "00:00:00", "closingTime": "23:59:59" }, { "dayOfWeek": 0, "openingTime": "00:00:00", "closingTime": "23:59:59" } ], "provider": null, "dateOfSupplyUtc": null, "estimateDate": "2024-07-15T15:40:00-03:00", "supplyLotId": null, "isExternal": false } ] ] } } } } } }, "/api/logistics/pvt/configuration/pickuppoints": { "get": { "tags": [ "Pickup points" ], "summary": "List pickup points", "description": "Retrieves information about your store [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\r\n\r\n>⚠️ The response is limited to 1.000 pickup points. If you need more results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "ListAllPickupPpoints", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List of pickup points, limited to 1.000 pickup points. If you need more than 1000 results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.", "items": { "$ref": "#/components/schemas/PickupPoint" } }, "example": [ { "id": "b8e7ca56", "name": "Pickup Shopping Center", "description": "Shopping Center from Barra", "instructions": "You have to present a document to collect your package", "formatted_address": "undefined", "address": { "postalCode": "22250040", "country": { "acronym": "BRA", "name": "Brazil" }, "city": "Rio de Janeiro", "state": "RJ", "neighborhood": "Botafogo", "street": "Botafogo beach", "number": "300", "complement": "Shopping Center", "reference": "Third floor", "location": { "latitude": -22.906847, "longitude": -43.172897 } }, "isActive": true, "distance": 0.0, "seller": "Fashion Skirts", "_sort": [ 1.57424039E+12 ], "businessHours": [ { "dayOfWeek": 1, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 2, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 3, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 4, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 5, "openingTime": "09:00:00", "closingTime": "18:00:00" } ], "tagsLabel": [ "w67", "p34" ], "pickupHolidays": [ { "date": "2024-12-28T03:00:00Z", "hourBegin": "09:00", "hourEnd": "13:00" }, { "date": "2024-11-17T03:00:00Z", "hourBegin": "00:00", "hourEnd": "00:00" } ], "isThirdPartyPickup": false, "accountOwnerName": "Fashion Store", "accountOwnerId": "1b4018ec-48bf-4a59-9eae-547403e11afc", "parentAccountName": "Fashion Store", "originalId": null }, { "id": "792893547449051", "name": "Bleu PUP", "description": "Bleu Store", "instructions": "You must present a document to collect your order", "formatted_address": "undefined", "address": { "postalCode": "18550-000", "country": { "acronym": "BRA", "name": "Brasil" }, "city": "Boituva", "state": "SP", "neighborhood": "Tancredo Neves", "street": "BTV-250", "number": "01", "complement": "Second floor", "reference": "Next to the city hall", "location": { "latitude": -23.2863329, "longitude": -47.6783742 } }, "isActive": true, "distance": 1574240387072.0, "seller": "Recurrency", "_sort": [ 1.57424039E+12 ], "businessHours": [ { "dayOfWeek": 1, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 2, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 3, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 4, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 5, "openingTime": "09:00:00", "closingTime": "18:00:00" } ], "tagsLabel": [ "kr47", "yk15" ], "pickupHolidays": [ { "date": "2024-12-28T03:00:00Z", "hourBegin": "09:00", "hourEnd": "13:00" } ], "isThirdPartyPickup": false, "accountOwnerName": "sportsstore", "accountOwnerId": "9ddcfba5-3855-49ec-b61e-b2847b9314cc", "parentAccountName": "sportsstore", "originalId": "b8e7ca56" } ] } } } } } }, "/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}": { "put": { "tags": [ "Pickup points" ], "summary": "Create or update pickup point", "description": "Creates or updates a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store, searching by pickup point ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "CreateUpdatePickupPoint", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "pickupPointId", "in": "path", "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID. Cannot contain spaces.", "required": true, "style": "simple", "schema": { "type": "string", "example": "b8e7ca56" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "id", "name", "description", "instructions", "formatted_address", "address", "isActive", "businessHours", "tagsLabel" ], "type": "object", "properties": { "id": { "type": "string", "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID. Cannot contain spaces.", "example": "b8e7ca56" }, "name": { "type": "string", "description": "Pickup point name displayed to customers at checkout.", "example": "Pickup store." }, "description": { "type": "string", "description": "Pickup point description.", "example": "Pickup your items in our store." }, "instructions": { "type": "string", "description": "Pickup point instructions.", "example": "Bring your ID in order to pickup your order." }, "formatted_address": { "type": "string", "description": "Formatted address.", "example": "undefined" }, "address": { "required": [ "postalCode", "country", "city", "state", "neighborhood", "street", "number", "complement", "reference", "location" ], "type": "object", "description": "Pickup point address information.", "properties": { "postalCode": { "type": "string", "description": "Pickup point address postal code.", "example": "22070002" }, "country": { "required": [ "acronym", "name" ], "type": "object", "description": "Information about the pickup point address country.", "properties": { "acronym": { "type": "string", "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.", "example": "BRA" }, "name": { "type": "string", "description": "Country name of the pickup point address.", "example": "Brazil" } } }, "city": { "type": "string", "description": "Pickup point address city.", "example": "Rio de Janeiro" }, "state": { "type": "string", "description": "Pickup point address state.", "example": "RJ" }, "neighborhood": { "type": "string", "description": "Pickup point address neighborhood.", "example": "Botafogo" }, "street": { "type": "string", "description": "Pickup point address street.", "example": "Praia de botafogo." }, "number": { "type": "string", "description": "Pickup point address number.", "example": "200" }, "complement": { "type": "string", "description": "Pickup point address complement.", "example": "3rd floor" }, "reference": { "type": "string", "description": "Reference point to help the customer find the pickup point.", "example": "Grey building" }, "location": { "required": [ "latitude", "longitude" ], "type": "object", "description": "Pickup point address geolocation coordinates.", "properties": { "latitude": { "type": "number", "description": "Latitude coordinate.", "example": -22.974477767944336 }, "longitude": { "type": "number", "description": "Longitude coordinate.", "example": -43.18672561645508 } } } } }, "isActive": { "type": "boolean", "description": "Defines if the pickup point is active (`true`) or inactive (`false`).", "example": true }, "businessHours": { "type": "array", "items": { "required": [ "dayOfWeek", "openingTime", "closingTime" ], "type": "object", "description": "Business hours configurations from Monday to Friday.", "properties": { "dayOfWeek": { "type": "integer", "format": "int32", "description": "Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday.", "example": 1, "enum": [ 1, 2, 3, 4, 5 ] }, "openingTime": { "type": "string", "description": "Opening time in `HH:MM:SS` format.", "example": "08:00:00" }, "closingTime": { "type": "string", "description": "Closing time in `HH:MM:SS` format.", "example": "20:00:00" } } }, "description": "Pickup point business hours configurations." }, "tagsLabel": { "type": "array", "items": { "type": "string", "description": "Pickup point tag label.", "example": "w67" }, "description": "Tags that identify a group of pickup points.", "example": [ "w67", "p34" ] }, "isThirdPartyPickup": { "type": "boolean", "description": "Defines if the pickup point is third-party (`true`) or not (`false`).", "example": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PickupPoint" }, "example": { "id": "b8e7ca56", "name": "Pickup Shopping Center", "description": "Shopping Center from Barra", "instructions": "You have to present a document to collect your package", "formatted_address": "undefined", "address": { "postalCode": "22250040", "country": { "acronym": "BRA", "name": "Brazil" }, "city": "Rio de Janeiro", "state": "RJ", "neighborhood": "Botafogo", "street": "Botafogo beach", "number": "300", "complement": "Shopping Center", "reference": "Third floor", "location": { "latitude": -22.906847, "longitude": -43.172897 } }, "isActive": true, "distance": 0.0, "seller": "Fashion Skirts", "_sort": [ 1.57424039E+12 ], "businessHours": [ { "dayOfWeek": 1, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 2, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 3, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 4, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 5, "openingTime": "09:00:00", "closingTime": "18:00:00" } ], "tagsLabel": [ "w67", "p34" ], "pickupHolidays": [ { "date": "2024-12-28T03:00:00Z", "hourBegin": "09:00", "hourEnd": "13:00" }, { "date": "2024-11-17T03:00:00Z", "hourBegin": "00:00", "hourEnd": "00:00" } ], "isThirdPartyPickup": false, "accountOwnerName": "fashionstore", "accountOwnerId": "1b4018ec-48bf-4a59-9eae-547403e11afc", "parentAccountName": "fashionstore", "originalId": "b8e7ca56" } } } } } }, "get": { "tags": [ "Pickup points" ], "summary": "List pickup point by ID", "description": "Retrieves information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), searching by pickup point ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "GetById", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "pickupPointId", "in": "path", "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "b8e7ca56" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PickupPoint" }, "example": { "id": "b8e7ca56", "name": "Pickup Shopping Center", "description": "Shopping Center from Barra", "instructions": "You have to present a document to collect your package", "formatted_address": "undefined", "address": { "postalCode": "22250040", "country": { "acronym": "BRA", "name": "Brazil" }, "city": "Rio de Janeiro", "state": "RJ", "neighborhood": "Botafogo", "street": "Botafogo beach", "number": "300", "complement": "Shopping Center", "reference": "Third floor", "location": { "latitude": -22.906847, "longitude": -43.172897 } }, "isActive": true, "distance": 0.0, "seller": "Fashion Skirts", "_sort": [ 1.57424039E+12 ], "businessHours": [ { "dayOfWeek": 1, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 2, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 3, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 4, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 5, "openingTime": "09:00:00", "closingTime": "18:00:00" } ], "tagsLabel": [ "w67", "p34" ], "pickupHolidays": [ { "date": "2024-12-28T03:00:00Z", "hourBegin": "09:00", "hourEnd": "13:00" }, { "date": "2024-11-17T03:00:00Z", "hourBegin": "00:00", "hourEnd": "00:00" } ], "isThirdPartyPickup": false, "accountOwnerName": "fashionstore", "accountOwnerId": "1b4018ec-48bf-4a59-9eae-547403e11afc", "parentAccountName": "fashionstore", "originalId": "b8e7ca56" } } } } } }, "delete": { "tags": [ "Pickup points" ], "summary": "Delete pickup point", "description": "Deletes a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store, searching by pickup point ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Delete", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "pickupPointId", "in": "path", "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "b8e7ca56" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/logistics/pvt/configuration/pickuppoints/_search": { "get": { "tags": [ "Pickup points" ], "summary": "List paged pickup points", "description": "Lists paged [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store.\r\n\r\n>⚠️ The response is limited to 100 pages.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "Getpaged", "parameters": [ { "name": "page", "in": "query", "description": "Number of the page of the response. When not informed, the default page returned is `1`, but you can use this parameter to retrieve a specific page. The response is limited to 100 pages.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 2 } }, { "name": "pageSize", "in": "query", "description": "Number of [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) per page.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 15 } }, { "name": "keyword", "in": "query", "description": "Search pickup points by using a keyword.", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "Rio" } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Paged pickup points list.", "properties": { "items": { "type": "array", "description": "List of pickup points.", "items": { "$ref": "#/components/schemas/PickupPoint" } }, "paging": { "type": "object", "description": "Pagination information.", "properties": { "page": { "type": "integer", "description": "Number of the current page of the response. By default, it returns page `1`, unless a different value is informed in the `page` query parameter." }, "perPage": { "type": "integer", "description": "Number of pickup points per page." }, "total": { "type": "integer", "description": "Total number of existing pickup points." }, "pages": { "type": "integer", "description": "Total number of pages, considering the total number of pickup points. Even though there might be other results, the maximum value of this field will be `100`, because the response is limited to 100 pages." } } } } }, "example": { "items": [ { "id": "b8e7ca56", "name": "Pickup Shopping Center", "description": "Shopping Center from Barra", "instructions": "You have to present a document to collect your package", "formatted_address": "undefined", "address": { "postalCode": "22250040", "country": { "acronym": "BRA", "name": "Brazil" }, "city": "Rio de Janeiro", "state": "RJ", "neighborhood": "Botafogo", "street": "Botafogo beach", "number": "300", "complement": "Shopping Center", "reference": "Third floor", "location": { "latitude": -22.906847, "longitude": -43.172897 } }, "isActive": true, "distance": 0.0, "seller": "Fashion Skirts", "_sort": [ 1.57424039E+12 ], "businessHours": [ { "dayOfWeek": 1, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 2, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 3, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 4, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 5, "openingTime": "09:00:00", "closingTime": "18:00:00" } ], "tagsLabel": [ "w67", "p34" ], "pickupHolidays": [ { "date": "2024-12-28T03:00:00Z", "hourBegin": "09:00", "hourEnd": "13:00" }, { "date": "2024-11-17T03:00:00Z", "hourBegin": "00:00", "hourEnd": "00:00" } ], "isThirdPartyPickup": false, "accountOwnerName": "Fashion Store", "accountOwnerId": "1b4018ec-48bf-4a59-9eae-547403e11afc", "parentAccountName": "Fashion Store", "originalId": null }, { "id": "792893547449051", "name": "Bleu PUP", "description": "Bleu Store", "instructions": "You must present a document to collect your order", "formatted_address": "undefined", "address": { "postalCode": "18550-000", "country": { "acronym": "BRA", "name": "Brasil" }, "city": "Boituva", "state": "SP", "neighborhood": "Tancredo Neves", "street": "BTV-250", "number": "01", "complement": "Second floor", "reference": "Next to the city hall", "location": { "latitude": -23.2863329, "longitude": -47.6783742 } }, "isActive": true, "distance": 1574240387072.0, "seller": "Recurrency", "_sort": [ 1.57424039E+12 ], "businessHours": [ { "dayOfWeek": 1, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 2, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 3, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 4, "openingTime": "09:00:00", "closingTime": "18:00:00" }, { "dayOfWeek": 5, "openingTime": "09:00:00", "closingTime": "18:00:00" } ], "tagsLabel": [ "kr47", "yk15" ], "pickupHolidays": [ { "date": "2024-12-28T03:00:00Z", "hourBegin": "09:00", "hourEnd": "13:00" } ], "isThirdPartyPickup": false, "accountOwnerName": "sportsstore", "accountOwnerId": "9ddcfba5-3855-49ec-b61e-b2847b9314cc", "parentAccountName": "sportsstore", "originalId": "b8e7ca56" } ], "paging": { "page": 1, "perPage": 15, "total": 29, "pages": 2 } } } } } } } }, "/api/logistics/pvt/configuration/geoshape": { "get": { "tags": [ "Polygons" ], "summary": "List paged polygons", "description": "Lists paged [polygons](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "PagedPolygons", "parameters": [ { "name": "page", "in": "query", "description": "Number of the page of the response.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 2 } }, { "name": "perPage", "in": "query", "description": "Number of [polygons](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) per page.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "example": 15 } }, { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "description": "Polygons list.", "items": { "type": "string", "description": "Polygon name." } }, "paging": { "type": "object", "description": "Pagination information.", "properties": { "page": { "type": "integer", "description": "Number of the current page of the response. By default, it returns page `1`." }, "perPage": { "type": "integer", "description": "Number of polygons per page." }, "total": { "type": "integer", "description": "Total number of existing polygons." }, "pages": { "type": "integer", "description": "Total number of pages, considering the total number of polygons." } } } } }, "example": { "items": [ "ipanema_leblon", "SP", "south_brazil" ], "paging": { "page": 1, "perPage": 15, "total": 22, "pages": 2 } } } } } } }, "put": { "tags": [ "Polygons" ], "summary": "Create or update polygon", "description": "Creates or updates a [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store, using geolocation coordinates.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "CreateUpdatePolygon", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "geoShape" ], "properties": { "name": { "type": "string", "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) being created or updated.", "example": "ipanema_leblon" }, "geoShape": { "type": "object", "description": "Polygon geolocation coordinates.", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "description": "List of geolocation coordinates that make part of the polygon.", "items": { "type": "array", "description": "Polygon geolocation coordinates. The first and the last pair of coordinates must be equal.", "items": { "type": "array", "description": "Polygon geolocation coordinates, first longitude then latitude.", "items": { "type": "number", "description": "Longitude or latitude.", "example": -43.231716156005859 } } }, "example": [ [ [ -43.231716156005859, -22.990713500405295 ], [ -43.182621002197266, -22.990713500405295 ], [ -43.182621002197266, -22.977043559707305 ], [ -43.231716156005859, -22.977043559707305 ], [ -43.231716156005859, -22.990713500405295 ] ] ] } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) created or updated." }, "example": "ipanema_leblon" } } }, "400": { "description": "Bad Request" } } } }, "/api/logistics/pvt/configuration/geoshape/{polygonName}": { "get": { "tags": [ "Polygons" ], "summary": "List polygon by ID", "description": "Retrieves information about a [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store, searching by polygon ID.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "PolygonbyId", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "polygonName", "in": "path", "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID (same as the polygon name).", "required": true, "style": "simple", "schema": { "type": "string", "example": "ipanema_leblon" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Defines if the polygon is active (`true`) or inactive (`false`)." }, "name": { "type": "string", "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID, which is the same as the polygon name." }, "geoShape": { "type": "object", "description": "Polygon geolocation coordinates.", "properties": { "coordinates": { "type": "array", "description": "List of geolocation coordinates that make part of the polygon.", "items": { "type": "array", "description": "Polygon geolocation coordinates. The first and the last pair of coordinates must be equal.", "items": { "type": "array", "description": "Polygon geolocation coordinates, first longitude then latitude.", "items": { "type": "number", "description": "Longitude or latitude." } } } }, "type": { "type": "string", "description": "Polygon identification." } } } } }, "example": { "isActive": true, "name": "ipanema_leblon", "geoShape": { "coordinates": [ [ [ -43.231716156005859, -22.990713500405295 ], [ -43.182621002197266, -22.990713500405295 ], [ -43.182621002197266, -22.977043559707305 ], [ -43.231716156005859, -22.977043559707305 ], [ -43.231716156005859, -22.990713500405295 ] ] ], "type": "polygon" } } } } } } }, "delete": { "tags": [ "Polygons" ], "summary": "Delete polygon", "description": "Deletes a [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store, searching by polygon ID.\r\n\r\nSuccessful requests receive a `200 OK` status code with `true` in the response body.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "operationId": "DeletePolygon", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "polygonName", "in": "path", "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID (same as the polygon name).", "required": true, "style": "simple", "schema": { "type": "string", "example": "ipanema_leblon" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "description": "Successful requests return the message `true`." }, "example": true } } } } } }, "/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames": { "get": { "tags": [ "Scheduled delivery" ], "summary": "Search capacity reservations in time range", "description": "Retrieves information of all [capacity reservations](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) made to scheduled delivery windows in a given time range.\r\n\r\n>⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the VTEX account.\n\r\n\r> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a `resource` in request messages.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/vnd.vtex.availability.v1+json" } }, { "name": "capacityType", "in": "path", "description": "Defines how the [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) is set in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140), which can be by maximum number of orders (`orders_quantity`) or items (`skus_quantity`).", "required": true, "style": "simple", "schema": { "type": "string", "example": "orders_quantity" } }, { "name": "shippingPolicyId", "in": "path", "description": "ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) being searched for capacity reservation.", "required": true, "style": "simple", "schema": { "type": "string", "example": "168e017" } }, { "name": "rangeStart", "in": "query", "description": "Starting date range in the format `YYYY-MM-DD`.", "required": true, "style": "form", "schema": { "type": "string", "example": "2024-07-19" } }, { "name": "rangeEnd", "in": "query", "description": "Ending date range in the format `YYYY-MM-DD`.", "required": true, "style": "form", "schema": { "type": "string", "example": "2024-07-26" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryCapacity" }, "example": { "id": "2024-07-19F1300T1700", "resourceId": "carrier@skus_quantity@168e017", "startDate": "2024-07-19T13:00:00+00:00", "endDate": "2024-07-26T17:00:59+00:00", "ownMaxCapacity": 10.0, "resourceMaxCapacity": 16.0, "reservedValue": 6.0, "reservations": [ { "id": "SLR-1379840726134-01", "value": 4.0 }, { "id": "SLR-1379840726341-01", "value": 2.0 } ], "log": [ { "when": "2024-07-20T15:56:09.1732357+00:00", "who": "Daniel Thompson", "why": "Reservation `SLR-1379840726134-01` with 4.0 units.", "what": "Unblocked" }, { "when": "2024-07-22T17:29:11.9250354+00:00", "who": "Daniel Thompson", "why": "Reservation `SLR-1379840726341-01` with 2.0 units.", "what": "Unblocked" } ] } } } } } } }, "/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime}": { "get": { "tags": [ "Scheduled delivery" ], "summary": "Get capacity reservation usage by window", "description": "Retrieves capacity usage of a specific [scheduled delivery](https://help.vtex.com/en/tutorial/entrega-agendada--22g3HAVCGLFiU7xugShOBi) reservation window.\n\r\n\r>⚠️ While most API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the VTEX account.\n\r\n\r> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a \"resource\" in the API's messages.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "default": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/vnd.vtex.availability.v1+json" } }, { "name": "capacityType", "in": "path", "description": "Defines how the [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) is set in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140), which can be by maximum number of orders (`orders_quantity`) or items (`skus_quantity`).", "required": true, "style": "simple", "schema": { "type": "string", "example": "orders_quantity" } }, { "name": "shippingPolicyId", "in": "path", "description": "ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) being searched for capacity reservation.", "required": true, "style": "simple", "schema": { "type": "string", "example": "168e017" } }, { "name": "windowDay", "in": "path", "description": "Date of the [scheduled delivery window](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) being consulted for reservations. The format is `YYYY-MM-DD`.", "required": true, "style": "simple", "schema": { "type": "string", "example": "2024-07-19" } }, { "name": "windowStartTime", "in": "path", "description": "Starting time of the scheduled delivery window being consulted for reservations. The format is `HHMM`.", "required": true, "style": "simple", "schema": { "type": "string", "example": "1030" } }, { "name": "windowEndTime", "in": "path", "description": "Ending time of the scheduled delivery window being consulted for reservations. The format is `HHMM`.", "required": true, "style": "simple", "schema": { "type": "string", "example": "1159" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryCapacity" }, "example": { "id": "2024-07-19F1300T1700", "resourceId": "carrier@skus_quantity@168e017", "startDate": "2024-07-19T13:00:00+00:00", "endDate": "2024-07-26T17:00:59+00:00", "ownMaxCapacity": 10.0, "resourceMaxCapacity": 16.0, "reservedValue": 6.0, "reservations": [ { "id": "SLR-1379840726134-01", "value": 4.0 }, { "id": "SLR-1379840726341-01", "value": 2.0 } ], "log": [ { "when": "2024-07-20T15:56:09.1732357+00:00", "who": "Daniel Thompson", "why": "Reservation `SLR-1379840726134-01` with 4.0 units.", "what": "Unblocked" }, { "when": "2024-07-22T17:29:11.9250354+00:00", "who": "Daniel Thompson", "why": "Reservation `SLR-1379840726341-01` with 2.0 units.", "what": "Unblocked" } ] } } } } } } } }, "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "components": { "parameters": { "Content-Type": { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, "Accept": { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } } }, "schemas": { "PickupPoint": { "type": "object", "description": "Pickup point information.", "properties": { "id": { "type": "string", "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID." }, "name": { "type": "string", "description": "Pickup point name displayed to customers at checkout." }, "description": { "type": "string", "description": "Pickup point description displayed to customers at checkout." }, "instructions": { "type": "string", "description": "Instructions for customers when collecting their package." }, "formatted_address": { "type": "string", "description": "Formatted address.", "nullable": true }, "address": { "type": "object", "description": "Pickup point address information.", "properties": { "postalCode": { "type": "string", "description": "Pickup point address postal code." }, "country": { "type": "object", "description": "Information about the pickup point address country.", "properties": { "acronym": { "type": "string", "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "name": { "type": "string", "description": "Country name of the pickup point address." } } }, "city": { "type": "string", "description": "Pickup point address city." }, "state": { "type": "string", "description": "Pickup point address state." }, "neighborhood": { "type": "string", "description": "Pickup point address neighborhood." }, "street": { "type": "string", "description": "Pickup point address street." }, "number": { "type": "string", "description": "Pickup point address number." }, "complement": { "type": "string", "description": "Pickup point address complement." }, "reference": { "type": "string", "description": "Reference point to help the customer find the pickup point." }, "location": { "type": "object", "description": "Pickup point address geolocation coordinates.", "properties": { "latitude": { "type": "number", "description": "Latitude coordinate." }, "longitude": { "type": "number", "description": "Longitude coordinate." } } } } }, "isActive": { "type": "boolean", "description": "Defines if the pickup point is active (`true`) or inactive (`false`)." }, "distance": { "type": "number", "description": "Pickup point configured distance." }, "seller": { "type": "string", "description": "Seller that corresponds to the pickup point." }, "_sort": { "type": "array", "description": "Sort array.", "items": { "type": "number", "description": "Pickup point sort information." } }, "businessHours": { "type": "array", "description": "Pickup point business hours configurations.", "items": { "type": "object", "description": "Business hours configurations from Monday to Friday.", "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday." }, "openingTime": { "type": "string", "description": "Opening time in `HH:MM:SS` format." }, "closingTime": { "type": "string", "description": "Closing time in `HH:MM:SS` format." } } } }, "tagsLabel": { "type": "array", "description": "Tags that identify a group of pickup points.", "items": { "type": "string", "description": "Pickup point tag label." } }, "pickupHolidays": { "type": "array", "description": "[Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.", "items": { "type": "object", "description": "Holiday information.", "properties": { "date": { "type": "string", "description": "Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`." }, "hourBegin": { "type": "string", "description": "Holiday beginning time in `HH:MM` format." }, "hourEnd": { "type": "string", "description": "Holiday ending time in `HH:MM` format." } } } }, "isThirdPartyPickup": { "type": "boolean", "description": "Defines if the pickup point is third-party (`true`) or not (`false`)." }, "accountOwnerName": { "type": "string", "description": "Account owner name." }, "accountOwnerId": { "type": "string", "description": "Account owner ID." }, "parentAccountName": { "type": "string", "description": "Parent account name." }, "originalId": { "type": "string", "description": "Original ID.", "nullable": true } } }, "ListDocksById": { "type": "object", "description": "Loading dock information.", "properties": { "pickupStoreInfo": { "type": "object", "description": "Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", "deprecated": true, "properties": { "isPickupStore": { "type": "boolean", "description": "Defines if the shipping type was pickup (`true`) or not (`false`).", "nullable": true, "deprecated": true }, "storeId": { "type": "string", "description": "Store ID for stores that acted as pickup points.", "nullable": true, "deprecated": true }, "friendlyName": { "type": "string", "description": "Name of the pickup point displayed at checkout.", "nullable": true, "deprecated": true }, "address": { "type": "object", "description": "Pickup point address information.", "nullable": true, "deprecated": true, "properties": { "postalCode": { "type": "string", "description": "Pickup point address postal code.", "deprecated": true }, "country": { "type": "object", "description": "Information about the pickup point address country.", "deprecated": true, "properties": { "acronym": { "type": "string", "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.", "deprecated": true }, "name": { "type": "string", "description": "Country name of the pickup point address.", "deprecated": true } } }, "city": { "type": "string", "description": "Pickup point address city.", "deprecated": true }, "state": { "type": "string", "description": "Pickup point address state.", "deprecated": true }, "neighborhood": { "type": "string", "description": "Pickup point address neighborhood.", "deprecated": true }, "street": { "type": "string", "description": "Pickup point address street.", "deprecated": true }, "number": { "type": "string", "description": "Pickup point address number.", "deprecated": true }, "complement": { "type": "string", "description": "Pickup point address complement.", "deprecated": true, "nullable": true }, "reference": { "type": "string", "description": "Pickup point address reference point.", "deprecated": true, "nullable": true }, "location": { "type": "object", "description": "Pickup point address geolocation coordinates.", "deprecated": true, "properties": { "latitude": { "type": "number", "description": "Latitude coordinate.", "deprecated": true }, "longitude": { "type": "number", "description": "Longitude coordinate.", "deprecated": true } } } } }, "additionalInfo": { "type": "string", "description": "Additional information about the delivery or the pickup point.", "nullable": true, "deprecated": true }, "dockId": { "type": "string", "description": "ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID.", "nullable": true, "deprecated": true }, "distance": { "type": "number", "description": "Distance in kilometers between the pickup point and the customer's address, measured as a straight line.", "nullable": true, "deprecated": true }, "businessHours": { "type": "string", "description": "Pickup point business hours configurations.", "nullable": true, "deprecated": true }, "pickupHolidays": { "type": "string", "description": "Holiday's configurations applicable to the pickup point.", "nullable": true, "deprecated": true }, "sellerId": { "type": "string", "description": "Seller ID.", "nullable": true, "deprecated": true }, "isThirdPartyPickup": { "type": "boolean", "description": "Defines if the pickup was third party (`true`) or not (`false`).", "deprecated": true } } }, "storeId": { "type": "string", "description": "Store ID.", "nullable": true }, "pickupInStoreInfo": { "type": "object", "description": "Information about the physical store as a pickup point.", "properties": { "isActice": { "type": "boolean", "description": "Defines if the physical store is a pickup point (`true`) or not (`false`)." }, "additionalInfo": { "type": "string", "description": "Additional information of the store as a pickup point.", "nullable": true } } }, "deliveryFromStoreInfo": { "type": "object", "description": "Settings for delivery from a physical store.", "properties": { "isActice": { "type": "boolean", "description": "Defines if the settings for delivery from physical stores are active (`true`) or inactive (`false`)." }, "deliveryRadius": { "type": "number", "description": "Delivery radius." }, "deliveryFee": { "type": "number", "description": "Delivery fee." }, "deliveryTime": { "type": "string", "description": "Delivery time in the format `DD.HH:MM:SS`." }, "maximumWeight": { "type": "number", "description": "Delivery maximum weight." } } }, "address": { "type": "object", "description": "Loading dock address.", "properties": { "postalCode": { "type": "string", "description": "Loading dock address postal code." }, "country": { "type": "object", "description": "Information about the loading dock address country.", "properties": { "acronym": { "type": "string", "description": "Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "name": { "type": "string", "description": "Country name of the loading dock address." } } }, "city": { "type": "string", "description": "Loading dock address city." }, "state": { "type": "string", "description": "Loading dock address state." }, "neighborhood": { "type": "string", "description": "Loading dock address neighborhood." }, "street": { "type": "string", "description": "Loading dock address street." }, "number": { "type": "string", "description": "Loading dock address number." }, "complement": { "type": "string", "description": "Loading dock address complement.", "nullable": true }, "reference": { "type": "string", "description": "Loading dock address reference point.", "nullable": true }, "location": { "type": "object", "description": "Loading dock address geolocation coordinates.", "properties": { "latitude": { "type": "number", "description": "Latitude coordinate." }, "longitude": { "type": "number", "description": "Longitude coordinate." } } } } }, "location": { "type": "object", "description": "Loading dock location details.", "nullable": true, "properties": { "zipCode": { "type": "string", "description": "Loading dock address postal code." }, "country": { "type": "string", "description": "Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format." }, "inStore": { "type": "object", "description": "Information related to orders made via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).", "properties": { "IsCheckedIn": { "type": "boolean", "description": "Defines if orders can be placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`)." }, "StoreId": { "type": "string", "description": "ID of purchases made in the GoCommerce context.", "nullable": true } } } } }, "shippingRatesProviders": { "type": "array", "description": "Shipping rates providers information.", "items": { "type": "string", "description": "Shipping rates." }, "nullable": true }, "deliveryAgreementsIds": { "type": "array", "description": "Delivery agreements IDs information.", "items": { "type": "string", "description": "Delivery agreements IDs." }, "nullable": true }, "id": { "type": "string", "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID." }, "name": { "type": "string", "description": "Loading dock name." }, "priority": { "type": "integer", "description": "Value from `0` to `10` used as a tie-breaking rule for loading dock selecting. The greater the priority, the greater the possibility of the loading dock being chosen in [shipping calculation](https://help.vtex.com/en/tutorial/how-shipping-calculation-works--tutorials_116). When no priority was set, it corresponds to `0`." }, "dockTimeFake": { "type": "string", "description": "Loading dock handling time in the format `DD.HH:MM:SS`.", "deprecated": true }, "timeFakeOverhead": { "type": "string", "description": "Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen. \r\n>ℹ️ This field is not considered when calculating the delivery time." }, "salesChannels": { "type": "array", "description": "Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock.", "items": { "type": "string", "description": "Sales channel ID." } }, "salesChannel": { "type": "string", "description": "Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock." }, "freightTableIds": { "type": "array", "description": "List with freight table IDs associated with the loading dock.", "items": { "type": "string", "description": "Freight table ID." } }, "wmsEndPoint": { "type": "string", "description": "Endpoint for integrating an external Warehouse Management System (WMS).", "nullable": true }, "isActive": { "type": "boolean", "description": "Defines if the loading dock is active (`true`) or inactive (`false`)." } } }, "DeliveryCapacity": { "type": "object", "description": "Information about the [capacity reservation](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).", "properties": { "id": { "type": "string", "description": "Capacity reservation ID generated by the request." }, "resourceId": { "type": "string", "description": "Combined string `carrier@{capacityType}@{shippingPolicyId}` used in the request." }, "startDate": { "type": "string", "description": "Starting date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account." }, "endDate": { "type": "string", "description": "Ending date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account." }, "ownMaxCapacity": { "type": "number", "description": "Delivery capacity available, which is the total capacity minus the reserved orders or items, according to the capacity type set." }, "resourceMaxCapacity": { "type": "number", "description": "Maximum delivery capacity of orders or items." }, "reservedValue": { "type": "number", "description": "Orders or items reserved from the delivery capacity." }, "reservations": { "type": "array", "description": "List of [reservations](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).", "items": { "type": "object", "description": "Reservation details.", "properties": { "id": { "type": "string", "description": "Reservation ID." }, "value": { "type": "number", "description": "Reservation number of items or orders, according to the capacity type set." } } } }, "log": { "type": "array", "description": "System processing information.", "items": { "type": "object", "description": "Log information.", "properties": { "when": { "type": "string", "description": "Delivery capacity alteration date and time, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account." }, "who": { "type": "string", "description": "Who altered the delivery capacity." }, "why": { "type": "string", "description": "Reason for the alteration." }, "what": { "type": "string", "description": "Situation of the corresponding [delivery window](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi#delivery-window), which can be `Blocked` or `Unblocked`." } } } } } }, "ShippingPolicy": { "type": "object", "description": "Details about a given shipping policy.", "properties": { "id": { "type": "string", "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID." }, "name": { "type": "string", "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name." }, "shippingMethod": { "type": "string", "description": "Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144)." }, "weekendAndHolidays": { "type": "object", "description": "If the shipping policy includes deliveries on weekends and holidays.", "properties": { "saturday": { "type": "boolean", "description": "Defines if shipping on Saturdays is valid (`true`) or not (`false`)." }, "sunday": { "type": "boolean", "description": "Defines if shipping on Sundays is valid (`true`) or not (`false`)." }, "holiday": { "type": "boolean", "description": "Defines if shipping on holidays is valid (`true`) or not (`false`)." } } }, "maxDimension": { "type": "object", "description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).", "properties": { "largestMeasure": { "type": "number", "description": "Largest measure acceptable of the package." }, "maxMeasureSum": { "type": "number", "description": "Limit for the sum of all maximum measures of the package." } } }, "numberOfItemsPerShipment": { "type": "integer", "description": "Determines the number of items allowed per shipment." }, "minimumValueAceptable": { "type": "number", "description": "Minimum value accepted by the carrier for delivering." }, "maximumValueAceptable": { "type": "number", "description": "Maximum value accepted by the carrier for delivering." }, "additionalTime": { "type": "string", "description": "Additional time configured in `HH:MM:SS` format.", "deprecated": true }, "additionalPrice": { "type": "object", "description": "Additional price object.", "properties": { "method": { "type": "integer", "description": "Additional price method.", "deprecated": true }, "value": { "type": "number", "description": "Payment value.", "deprecated": true } }, "deprecated": true }, "deliveryScheduleSettings": { "type": "object", "description": "[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings.", "properties": { "useDeliverySchedule": { "type": "boolean", "description": "Defines if the scheduled delivery configuration is active (`true`) or not (`false`)." }, "maxRangeDelivery": { "type": "number", "description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured `maxRangeDelivery` is equal `7`, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the `maxRangeDelivery` set, the shipping policy will not be shown on the checkout." }, "dayOfWeekForDelivery": { "type": "array", "description": "Selected days for delivery, from `0` (Sunday) to `6` (Saturday).", "items": { "type": "object", "description": "Selected days for delivery objects.", "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week, from `0` (Sunday) to `6` (Saturday)." }, "deliveryRanges": { "type": "array", "description": "Reservation window for scheduled delivery.", "items": { "type": "object", "description": "Reservation window for scheduled delivery object.", "properties": { "startTime": { "type": "string", "description": "Start time for day of the week in `hh:mm:ss` format." }, "endTime": { "type": "string", "description": "End time for day of the week in `hh:mm:ss` format." }, "listPrice": { "type": "number", "description": "List price for day of the week." }, "deliveryCapacity": { "type": "array", "description": "Sets maximum [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) for a given reservation window for scheduled delivery.", "nullable": true, "items": { "type": "object", "description": "Object with the maximum delivery capacity for a reservation window.", "properties": { "capacityType": { "type": "string", "description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`ORDERS_QUANTITY`) or items (`SKUS_QUANTITY`)." }, "maxValue": { "type": "number", "description": "Maximum number of orders or SKUs that the store is capable of fulfilling." } } } } } } } } } }, "dayOfWeekBlockeds":{ "type": "array", "description": "Defines if there are any days of the week that are blocked.", "items": { "type": "string", "description": "Date and time of the blocked day in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss`." }, "nullable": true, "deprecated": true } } }, "carrierSchedule": { "type": "array", "description": "Schedule sent by the carrier to configure the shipping policy.", "items": { "type": "object", "description": "Carrier schedule for configuring the shipping policy object.", "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week from `0` (Sunday) to `6` (Saturday)." }, "timeLimit": { "type": "string", "description": "Time limit in `HH:MM:SS` format." } } } }, "cubicWeightSettings": { "type": "object", "description": "Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.", "properties": { "volumetricFactor": { "type": "number", "description": "Factor that will be used on the cubic weight calculation, usually given by the carrier." }, "minimunAcceptableVolumetricWeight": { "type": "number", "description": "Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128)." } } }, "modalSettings": { "type": "object", "description": "Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.", "properties": { "modals": { "type": "array", "description": "Type of special freight.", "items": { "type": "string", "enum": [ "CHEMICALS", "ELECTRONICS", "FURNITURE", "GLASS", "LIQUID", "MATTRESSES", "REFRIGERATED", "TIRES", "WHITE_GOODS", "FIREARMS" ], "description": "Modal values assigned to the special freight." } }, "useOnlyItemsWithDefinedModal": { "type": "boolean", "description": "When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set." } } }, "businessHourSettings": { "type": "object", "description": "Business hours configurations.", "properties": { "carrierBusinessHours": { "type": "array", "description": "Business hours configurations array for the days of the week.", "items": { "type": "object", "description": "Business hours configurations for a single day of the week.", "properties": { "openingTime": { "type": "string", "description": "Opening time in `HH:MM:SS` format." }, "closingTime": { "type": "string", "description": "Closing time in `HH:MM:SS` format." }, "dayOfWeek": { "type": "integer", "description": "Day of the week from `0` (Sunday) to `6` (Saturday).", "enum": [ 0, 1, 2, 3, 4, 5, 6 ] } } } }, "isOpenOutsideBusinessHours": { "type": "boolean", "description": "Defines if deliveries outside business hours are allowed (`true`) or not (`false`)." } } }, "pickupPointsSettings": { "type": "object", "description": "[Pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) configurations of the shipping policy.", "properties": { "pickupPointIds": { "type": "array", "description": "Pickup point IDs configured for the shipping policy.", "items":{ "type": "string", "description": "Pickup point ID." } }, "pickupPointTags": { "type": "array", "description": "Pickup points tags configured for the shipping policy.", "items":{ "type": "string", "description": "Tag identification." } }, "sellers": { "type": "array", "description": "Sellers associated with [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the shipping policy.", "items":{ "type": "string", "description": "Sellers IDS." } } } }, "processingStatus": { "type": "object", "description": "Shipping policy processing status.", "properties": { "status": { "type": "integer", "format": "int32", "description": "Shipping policy processing status code." }, "errorMessage": { "type": "string", "description": "Error message, when applicable.", "nullable": true }, "errorsMetadata": { "type": "string", "description": "Error metadata, when applicable.", "nullable": true } } }, "deliveryChannel": { "type": "string", "description": "Defines if the shipping type is `delivery` or `pickup`." }, "calculationType": { "type": "integer", "description": "Shipping policy calculation type." }, "isActive": { "type": "boolean", "description": "Defines if the shipping policy is active (`true`) or not (`false`)." }, "lastIndexedAt": { "type": "string", "description": "Date and time since the last [indexing](https://help.vtex.com/en/tutorial/understanding-how-indexation-works--tutorials_256), in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`.", "nullable": true }, "shippingHoursSettings": { "type": "object", "description": "Shipping hours settings configurations.", "properties": { "shippingHours": { "type": "array", "description": "Shipping hours settings array.", "items": { "type": "object", "description": "Object with details on shipping hours settings.", "properties": { "dayOfWeek": { "type": "integer", "description": "Day of the week from `0` (Sunday) to `6` (Saturday)." }, "openingTime": { "type": "string", "description": "Opening time in `hh:mm:ss` format." }, "closingTime": { "type": "string", "description": "Closing time in `hh:mm:ss` format." } } } }, "acceptOrdersOutsideShippingHours": { "type": "boolean", "description": "Defines if the configuration that allows accepting orders outside shipping hours is active (`true`) or not (`false`)." } } }, "carrierInfo": { "type": "object", "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) information.", "properties": { "carrierAccountName": { "type": "string", "description": "VTEX store account name related to the shipping policy." }, "deliveryAgreementId": { "type": "string", "description": "Delivery agreement ID.", "nullable": true }, "linkedDocks": { "type": "array", "description": "Shipping policy [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) valid for the carrier.", "items": { "type": "object", "description": "Loading dock object.", "properties": { "id": { "type": "string", "description": "Loading dock ID." }, "name": { "type": "string", "description": "Loading dock name." } } } }, "readyToUse": { "type": "boolean", "description": "Defines if shipping configurations related to the carrier make them ready for shipping (`true`) or not (`false`)." } } } } } }, "securitySchemes": { "appKey": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppKey", "description": "Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "appToken": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppToken", "description": "Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "VtexIdclientAutCookie": { "type": "apiKey", "in": "header", "name": "VtexIdclientAutCookie", "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." } } }, "tags": [ { "name": "Scheduled delivery" }, { "name": "Shipping policies" }, { "name": "Docks" }, { "name": "Warehouses" }, { "name": "Inventory" }, { "name": "Holidays" }, { "name": "Reservations" }, { "name": "SLA" }, { "name": "Pickup points" }, { "name": "Polygons" }, { "name": "Freight values" } ] }